Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-network-profile-2019-03-01-hybrid

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AuthenticationMethod

AuthenticationMethod: "EAPTLS" | "EAPMSCHAPv2"

Defines values for AuthenticationMethod. Possible values include: 'EAPTLS', 'EAPMSCHAPv2'

readonly
enum

{string}

BgpPeerState

BgpPeerState: "Unknown" | "Stopped" | "Idle" | "Connecting" | "Connected"

Defines values for BgpPeerState. Possible values include: 'Unknown', 'Stopped', 'Idle', 'Connecting', 'Connected'

readonly
enum

{string}

DefaultSecurityRulesGetResponse

DefaultSecurityRulesGetResponse: SecurityRule & object

Contains response data for the get operation.

DefaultSecurityRulesListNextResponse

DefaultSecurityRulesListNextResponse: SecurityRuleListResult & object

Contains response data for the listNext operation.

DefaultSecurityRulesListResponse

DefaultSecurityRulesListResponse: SecurityRuleListResult & object

Contains response data for the list operation.

DhGroup

DhGroup: "None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24"

Defines values for DhGroup. Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24'

readonly
enum

{string}

EffectiveRouteSource

EffectiveRouteSource: "Unknown" | "User" | "VirtualNetworkGateway" | "Default"

Defines values for EffectiveRouteSource. Possible values include: 'Unknown', 'User', 'VirtualNetworkGateway', 'Default'

readonly
enum

{string}

EffectiveRouteState

EffectiveRouteState: "Active" | "Invalid"

Defines values for EffectiveRouteState. Possible values include: 'Active', 'Invalid'

readonly
enum

{string}

EffectiveSecurityRuleProtocol

EffectiveSecurityRuleProtocol: "Tcp" | "Udp" | "All"

Defines values for EffectiveSecurityRuleProtocol. Possible values include: 'Tcp', 'Udp', 'All'

readonly
enum

{string}

IPAllocationMethod

IPAllocationMethod: "Static" | "Dynamic"

Defines values for IPAllocationMethod. Possible values include: 'Static', 'Dynamic'

readonly
enum

{string}

IPVersion

IPVersion: "IPv4" | "IPv6"

Defines values for IPVersion. Possible values include: 'IPv4', 'IPv6'

readonly
enum

{string}

IkeEncryption

IkeEncryption: "DES" | "DES3" | "AES128" | "AES192" | "AES256"

Defines values for IkeEncryption. Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256'

readonly
enum

{string}

IkeIntegrity

IkeIntegrity: "MD5" | "SHA1" | "SHA256" | "SHA384"

Defines values for IkeIntegrity. Possible values include: 'MD5', 'SHA1', 'SHA256', 'SHA384'

readonly
enum

{string}

InboundNatRulesBeginCreateOrUpdateResponse

InboundNatRulesBeginCreateOrUpdateResponse: InboundNatRule & object

Contains response data for the beginCreateOrUpdate operation.

InboundNatRulesCreateOrUpdateResponse

InboundNatRulesCreateOrUpdateResponse: InboundNatRule & object

Contains response data for the createOrUpdate operation.

InboundNatRulesGetResponse

InboundNatRulesGetResponse: InboundNatRule & object

Contains response data for the get operation.

InboundNatRulesListNextResponse

InboundNatRulesListNextResponse: InboundNatRuleListResult & object

Contains response data for the listNext operation.

InboundNatRulesListResponse

InboundNatRulesListResponse: InboundNatRuleListResult & object

Contains response data for the list operation.

IpsecEncryption

IpsecEncryption: "None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256"

Defines values for IpsecEncryption. Possible values include: 'None', 'DES', 'DES3', 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256'

readonly
enum

{string}

IpsecIntegrity

IpsecIntegrity: "MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256"

Defines values for IpsecIntegrity. Possible values include: 'MD5', 'SHA1', 'SHA256', 'GCMAES128', 'GCMAES192', 'GCMAES256'

readonly
enum

{string}

LoadBalancerBackendAddressPoolsGetResponse

LoadBalancerBackendAddressPoolsGetResponse: BackendAddressPool & object

Contains response data for the get operation.

LoadBalancerBackendAddressPoolsListNextResponse

LoadBalancerBackendAddressPoolsListNextResponse: LoadBalancerBackendAddressPoolListResult & object

Contains response data for the listNext operation.

LoadBalancerBackendAddressPoolsListResponse

LoadBalancerBackendAddressPoolsListResponse: LoadBalancerBackendAddressPoolListResult & object

Contains response data for the list operation.

LoadBalancerFrontendIPConfigurationsGetResponse

LoadBalancerFrontendIPConfigurationsGetResponse: FrontendIPConfiguration & object

Contains response data for the get operation.

LoadBalancerFrontendIPConfigurationsListNextResponse

LoadBalancerFrontendIPConfigurationsListNextResponse: LoadBalancerFrontendIPConfigurationListResult & object

Contains response data for the listNext operation.

LoadBalancerFrontendIPConfigurationsListResponse

LoadBalancerFrontendIPConfigurationsListResponse: LoadBalancerFrontendIPConfigurationListResult & object

Contains response data for the list operation.

LoadBalancerLoadBalancingRulesGetResponse

LoadBalancerLoadBalancingRulesGetResponse: LoadBalancingRule & object

Contains response data for the get operation.

LoadBalancerLoadBalancingRulesListNextResponse

LoadBalancerLoadBalancingRulesListNextResponse: LoadBalancerLoadBalancingRuleListResult & object

Contains response data for the listNext operation.

LoadBalancerLoadBalancingRulesListResponse

LoadBalancerLoadBalancingRulesListResponse: LoadBalancerLoadBalancingRuleListResult & object

Contains response data for the list operation.

LoadBalancerNetworkInterfacesListNextResponse

LoadBalancerNetworkInterfacesListNextResponse: NetworkInterfaceListResult & object

Contains response data for the listNext operation.

LoadBalancerNetworkInterfacesListResponse

LoadBalancerNetworkInterfacesListResponse: NetworkInterfaceListResult & object

Contains response data for the list operation.

LoadBalancerProbesGetResponse

LoadBalancerProbesGetResponse: Probe & object

Contains response data for the get operation.

LoadBalancerProbesListNextResponse

LoadBalancerProbesListNextResponse: LoadBalancerProbeListResult & object

Contains response data for the listNext operation.

LoadBalancerProbesListResponse

LoadBalancerProbesListResponse: LoadBalancerProbeListResult & object

Contains response data for the list operation.

LoadBalancerSkuName

LoadBalancerSkuName: "Basic" | "Standard"

Defines values for LoadBalancerSkuName. Possible values include: 'Basic', 'Standard'

readonly
enum

{string}

LoadBalancersBeginCreateOrUpdateResponse

LoadBalancersBeginCreateOrUpdateResponse: LoadBalancer & object

Contains response data for the beginCreateOrUpdate operation.

LoadBalancersBeginUpdateTagsResponse

LoadBalancersBeginUpdateTagsResponse: LoadBalancer & object

Contains response data for the beginUpdateTags operation.

LoadBalancersCreateOrUpdateResponse

LoadBalancersCreateOrUpdateResponse: LoadBalancer & object

Contains response data for the createOrUpdate operation.

LoadBalancersGetResponse

LoadBalancersGetResponse: LoadBalancer & object

Contains response data for the get operation.

LoadBalancersListAllNextResponse

LoadBalancersListAllNextResponse: LoadBalancerListResult & object

Contains response data for the listAllNext operation.

LoadBalancersListAllResponse

LoadBalancersListAllResponse: LoadBalancerListResult & object

Contains response data for the listAll operation.

LoadBalancersListNextResponse

LoadBalancersListNextResponse: LoadBalancerListResult & object

Contains response data for the listNext operation.

LoadBalancersListResponse

LoadBalancersListResponse: LoadBalancerListResult & object

Contains response data for the list operation.

LoadBalancersUpdateTagsResponse

LoadBalancersUpdateTagsResponse: LoadBalancer & object

Contains response data for the updateTags operation.

LoadDistribution

LoadDistribution: "Default" | "SourceIP" | "SourceIPProtocol"

Defines values for LoadDistribution. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'

readonly
enum

{string}

LocalNetworkGatewaysBeginCreateOrUpdateResponse

LocalNetworkGatewaysBeginCreateOrUpdateResponse: LocalNetworkGateway & object

Contains response data for the beginCreateOrUpdate operation.

LocalNetworkGatewaysBeginUpdateTagsResponse

LocalNetworkGatewaysBeginUpdateTagsResponse: LocalNetworkGateway & object

Contains response data for the beginUpdateTags operation.

LocalNetworkGatewaysCreateOrUpdateResponse

LocalNetworkGatewaysCreateOrUpdateResponse: LocalNetworkGateway & object

Contains response data for the createOrUpdate operation.

LocalNetworkGatewaysGetResponse

LocalNetworkGatewaysGetResponse: LocalNetworkGateway & object

Contains response data for the get operation.

LocalNetworkGatewaysListNextResponse

LocalNetworkGatewaysListNextResponse: LocalNetworkGatewayListResult & object

Contains response data for the listNext operation.

LocalNetworkGatewaysListResponse

LocalNetworkGatewaysListResponse: LocalNetworkGatewayListResult & object

Contains response data for the list operation.

LocalNetworkGatewaysUpdateTagsResponse

LocalNetworkGatewaysUpdateTagsResponse: LocalNetworkGateway & object

Contains response data for the updateTags operation.

NetworkInterfaceIPConfigurationsGetResponse

NetworkInterfaceIPConfigurationsGetResponse: NetworkInterfaceIPConfiguration & object

Contains response data for the get operation.

NetworkInterfaceIPConfigurationsListNextResponse

NetworkInterfaceIPConfigurationsListNextResponse: NetworkInterfaceIPConfigurationListResult & object

Contains response data for the listNext operation.

NetworkInterfaceIPConfigurationsListResponse

NetworkInterfaceIPConfigurationsListResponse: NetworkInterfaceIPConfigurationListResult & object

Contains response data for the list operation.

NetworkInterfaceLoadBalancersListNextResponse

NetworkInterfaceLoadBalancersListNextResponse: NetworkInterfaceLoadBalancerListResult & object

Contains response data for the listNext operation.

NetworkInterfaceLoadBalancersListResponse

NetworkInterfaceLoadBalancersListResponse: NetworkInterfaceLoadBalancerListResult & object

Contains response data for the list operation.

NetworkInterfacesBeginCreateOrUpdateResponse

NetworkInterfacesBeginCreateOrUpdateResponse: NetworkInterface & object

Contains response data for the beginCreateOrUpdate operation.

NetworkInterfacesBeginGetEffectiveRouteTableResponse

NetworkInterfacesBeginGetEffectiveRouteTableResponse: EffectiveRouteListResult & object

Contains response data for the beginGetEffectiveRouteTable operation.

NetworkInterfacesBeginListEffectiveNetworkSecurityGroupsResponse

NetworkInterfacesBeginListEffectiveNetworkSecurityGroupsResponse: EffectiveNetworkSecurityGroupListResult & object

Contains response data for the beginListEffectiveNetworkSecurityGroups operation.

NetworkInterfacesBeginUpdateTagsResponse

NetworkInterfacesBeginUpdateTagsResponse: NetworkInterface & object

Contains response data for the beginUpdateTags operation.

NetworkInterfacesCreateOrUpdateResponse

NetworkInterfacesCreateOrUpdateResponse: NetworkInterface & object

Contains response data for the createOrUpdate operation.

NetworkInterfacesGetEffectiveRouteTableResponse

NetworkInterfacesGetEffectiveRouteTableResponse: EffectiveRouteListResult & object

Contains response data for the getEffectiveRouteTable operation.

NetworkInterfacesGetResponse

NetworkInterfacesGetResponse: NetworkInterface & object

Contains response data for the get operation.

NetworkInterfacesListAllNextResponse

NetworkInterfacesListAllNextResponse: NetworkInterfaceListResult & object

Contains response data for the listAllNext operation.

NetworkInterfacesListAllResponse

NetworkInterfacesListAllResponse: NetworkInterfaceListResult & object

Contains response data for the listAll operation.

NetworkInterfacesListEffectiveNetworkSecurityGroupsResponse

NetworkInterfacesListEffectiveNetworkSecurityGroupsResponse: EffectiveNetworkSecurityGroupListResult & object

Contains response data for the listEffectiveNetworkSecurityGroups operation.

NetworkInterfacesListNextResponse

NetworkInterfacesListNextResponse: NetworkInterfaceListResult & object

Contains response data for the listNext operation.

NetworkInterfacesListResponse

NetworkInterfacesListResponse: NetworkInterfaceListResult & object

Contains response data for the list operation.

NetworkInterfacesUpdateTagsResponse

NetworkInterfacesUpdateTagsResponse: NetworkInterface & object

Contains response data for the updateTags operation.

NetworkOperationStatus

NetworkOperationStatus: "InProgress" | "Succeeded" | "Failed"

Defines values for NetworkOperationStatus. Possible values include: 'InProgress', 'Succeeded', 'Failed'

readonly
enum

{string}

NetworkSecurityGroupsBeginCreateOrUpdateResponse

NetworkSecurityGroupsBeginCreateOrUpdateResponse: NetworkSecurityGroup & object

Contains response data for the beginCreateOrUpdate operation.

NetworkSecurityGroupsBeginUpdateTagsResponse

NetworkSecurityGroupsBeginUpdateTagsResponse: NetworkSecurityGroup & object

Contains response data for the beginUpdateTags operation.

NetworkSecurityGroupsCreateOrUpdateResponse

NetworkSecurityGroupsCreateOrUpdateResponse: NetworkSecurityGroup & object

Contains response data for the createOrUpdate operation.

NetworkSecurityGroupsGetResponse

NetworkSecurityGroupsGetResponse: NetworkSecurityGroup & object

Contains response data for the get operation.

NetworkSecurityGroupsListAllNextResponse

NetworkSecurityGroupsListAllNextResponse: NetworkSecurityGroupListResult & object

Contains response data for the listAllNext operation.

NetworkSecurityGroupsListAllResponse

NetworkSecurityGroupsListAllResponse: NetworkSecurityGroupListResult & object

Contains response data for the listAll operation.

NetworkSecurityGroupsListNextResponse

NetworkSecurityGroupsListNextResponse: NetworkSecurityGroupListResult & object

Contains response data for the listNext operation.

NetworkSecurityGroupsListResponse

NetworkSecurityGroupsListResponse: NetworkSecurityGroupListResult & object

Contains response data for the list operation.

NetworkSecurityGroupsUpdateTagsResponse

NetworkSecurityGroupsUpdateTagsResponse: NetworkSecurityGroup & object

Contains response data for the updateTags operation.

OperationsListNextResponse

OperationsListNextResponse: OperationListResult & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationListResult & object

Contains response data for the list operation.

PfsGroup

PfsGroup: "None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24"

Defines values for PfsGroup. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', 'ECP256', 'ECP384', 'PFS24'

readonly
enum

{string}

ProbeProtocol

ProbeProtocol: "Http" | "Tcp"

Defines values for ProbeProtocol. Possible values include: 'Http', 'Tcp'

readonly
enum

{string}

ProcessorArchitecture

ProcessorArchitecture: "Amd64" | "X86"

Defines values for ProcessorArchitecture. Possible values include: 'Amd64', 'X86'

readonly
enum

{string}

PublicIPAddressSkuName

PublicIPAddressSkuName: "Basic" | "Standard"

Defines values for PublicIPAddressSkuName. Possible values include: 'Basic', 'Standard'

readonly
enum

{string}

PublicIPAddressesBeginCreateOrUpdateResponse

PublicIPAddressesBeginCreateOrUpdateResponse: PublicIPAddress & object

Contains response data for the beginCreateOrUpdate operation.

PublicIPAddressesBeginUpdateTagsResponse

PublicIPAddressesBeginUpdateTagsResponse: PublicIPAddress & object

Contains response data for the beginUpdateTags operation.

PublicIPAddressesCreateOrUpdateResponse

PublicIPAddressesCreateOrUpdateResponse: PublicIPAddress & object

Contains response data for the createOrUpdate operation.

PublicIPAddressesGetResponse

PublicIPAddressesGetResponse: PublicIPAddress & object

Contains response data for the get operation.

PublicIPAddressesListAllNextResponse

PublicIPAddressesListAllNextResponse: PublicIPAddressListResult & object

Contains response data for the listAllNext operation.

PublicIPAddressesListAllResponse

PublicIPAddressesListAllResponse: PublicIPAddressListResult & object

Contains response data for the listAll operation.

PublicIPAddressesListNextResponse

PublicIPAddressesListNextResponse: PublicIPAddressListResult & object

Contains response data for the listNext operation.

PublicIPAddressesListResponse

PublicIPAddressesListResponse: PublicIPAddressListResult & object

Contains response data for the list operation.

PublicIPAddressesUpdateTagsResponse

PublicIPAddressesUpdateTagsResponse: PublicIPAddress & object

Contains response data for the updateTags operation.

RouteNextHopType

RouteNextHopType: "VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None"

Defines values for RouteNextHopType. Possible values include: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', 'None'

readonly
enum

{string}

RouteTablesBeginCreateOrUpdateResponse

RouteTablesBeginCreateOrUpdateResponse: RouteTable & object

Contains response data for the beginCreateOrUpdate operation.

RouteTablesBeginUpdateTagsResponse

RouteTablesBeginUpdateTagsResponse: RouteTable & object

Contains response data for the beginUpdateTags operation.

RouteTablesCreateOrUpdateResponse

RouteTablesCreateOrUpdateResponse: RouteTable & object

Contains response data for the createOrUpdate operation.

RouteTablesGetResponse

RouteTablesGetResponse: RouteTable & object

Contains response data for the get operation.

RouteTablesListAllNextResponse

RouteTablesListAllNextResponse: RouteTableListResult & object

Contains response data for the listAllNext operation.

RouteTablesListAllResponse

RouteTablesListAllResponse: RouteTableListResult & object

Contains response data for the listAll operation.

RouteTablesListNextResponse

RouteTablesListNextResponse: RouteTableListResult & object

Contains response data for the listNext operation.

RouteTablesListResponse

RouteTablesListResponse: RouteTableListResult & object

Contains response data for the list operation.

RouteTablesUpdateTagsResponse

RouteTablesUpdateTagsResponse: RouteTable & object

Contains response data for the updateTags operation.

RoutesBeginCreateOrUpdateResponse

RoutesBeginCreateOrUpdateResponse: Route & object

Contains response data for the beginCreateOrUpdate operation.

RoutesCreateOrUpdateResponse

RoutesCreateOrUpdateResponse: Route & object

Contains response data for the createOrUpdate operation.

RoutesGetResponse

RoutesGetResponse: Route & object

Contains response data for the get operation.

RoutesListNextResponse

RoutesListNextResponse: RouteListResult & object

Contains response data for the listNext operation.

RoutesListResponse

RoutesListResponse: RouteListResult & object

Contains response data for the list operation.

SecurityRuleAccess

SecurityRuleAccess: "Allow" | "Deny"

Defines values for SecurityRuleAccess. Possible values include: 'Allow', 'Deny'

readonly
enum

{string}

SecurityRuleDirection

SecurityRuleDirection: "Inbound" | "Outbound"

Defines values for SecurityRuleDirection. Possible values include: 'Inbound', 'Outbound'

readonly
enum

{string}

SecurityRuleProtocol

SecurityRuleProtocol: "Tcp" | "Udp" | "*"

Defines values for SecurityRuleProtocol. Possible values include: 'Tcp', 'Udp', '*'

readonly
enum

{string}

SecurityRulesBeginCreateOrUpdateResponse

SecurityRulesBeginCreateOrUpdateResponse: SecurityRule & object

Contains response data for the beginCreateOrUpdate operation.

SecurityRulesCreateOrUpdateResponse

SecurityRulesCreateOrUpdateResponse: SecurityRule & object

Contains response data for the createOrUpdate operation.

SecurityRulesGetResponse

SecurityRulesGetResponse: SecurityRule & object

Contains response data for the get operation.

SecurityRulesListNextResponse

SecurityRulesListNextResponse: SecurityRuleListResult & object

Contains response data for the listNext operation.

SecurityRulesListResponse

SecurityRulesListResponse: SecurityRuleListResult & object

Contains response data for the list operation.

SubnetsBeginCreateOrUpdateResponse

SubnetsBeginCreateOrUpdateResponse: Subnet & object

Contains response data for the beginCreateOrUpdate operation.

SubnetsCreateOrUpdateResponse

SubnetsCreateOrUpdateResponse: Subnet & object

Contains response data for the createOrUpdate operation.

SubnetsGetResponse

SubnetsGetResponse: Subnet & object

Contains response data for the get operation.

SubnetsListNextResponse

SubnetsListNextResponse: SubnetListResult & object

Contains response data for the listNext operation.

SubnetsListResponse

SubnetsListResponse: SubnetListResult & object

Contains response data for the list operation.

TransportProtocol

TransportProtocol: "Udp" | "Tcp" | "All"

Defines values for TransportProtocol. Possible values include: 'Udp', 'Tcp', 'All'

readonly
enum

{string}

VirtualNetworkGatewayConnectionStatus

VirtualNetworkGatewayConnectionStatus: "Unknown" | "Connecting" | "Connected" | "NotConnected"

Defines values for VirtualNetworkGatewayConnectionStatus. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected'

readonly
enum

{string}

VirtualNetworkGatewayConnectionType

VirtualNetworkGatewayConnectionType: "IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient"

Defines values for VirtualNetworkGatewayConnectionType. Possible values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient'

readonly
enum

{string}

VirtualNetworkGatewayConnectionsBeginCreateOrUpdateResponse

VirtualNetworkGatewayConnectionsBeginCreateOrUpdateResponse: VirtualNetworkGatewayConnection & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworkGatewayConnectionsBeginResetSharedKeyResponse

VirtualNetworkGatewayConnectionsBeginResetSharedKeyResponse: ConnectionResetSharedKey & object

Contains response data for the beginResetSharedKey operation.

VirtualNetworkGatewayConnectionsBeginSetSharedKeyResponse

VirtualNetworkGatewayConnectionsBeginSetSharedKeyResponse: ConnectionSharedKey & object

Contains response data for the beginSetSharedKey operation.

VirtualNetworkGatewayConnectionsBeginUpdateTagsResponse

VirtualNetworkGatewayConnectionsBeginUpdateTagsResponse: VirtualNetworkGatewayConnectionListEntity & object

Contains response data for the beginUpdateTags operation.

VirtualNetworkGatewayConnectionsCreateOrUpdateResponse

VirtualNetworkGatewayConnectionsCreateOrUpdateResponse: VirtualNetworkGatewayConnection & object

Contains response data for the createOrUpdate operation.

VirtualNetworkGatewayConnectionsGetResponse

VirtualNetworkGatewayConnectionsGetResponse: VirtualNetworkGatewayConnection & object

Contains response data for the get operation.

VirtualNetworkGatewayConnectionsGetSharedKeyResponse

VirtualNetworkGatewayConnectionsGetSharedKeyResponse: ConnectionSharedKey & object

Contains response data for the getSharedKey operation.

VirtualNetworkGatewayConnectionsListNextResponse

VirtualNetworkGatewayConnectionsListNextResponse: VirtualNetworkGatewayConnectionListResult & object

Contains response data for the listNext operation.

VirtualNetworkGatewayConnectionsListResponse

VirtualNetworkGatewayConnectionsListResponse: VirtualNetworkGatewayConnectionListResult & object

Contains response data for the list operation.

VirtualNetworkGatewayConnectionsResetSharedKeyResponse

VirtualNetworkGatewayConnectionsResetSharedKeyResponse: ConnectionResetSharedKey & object

Contains response data for the resetSharedKey operation.

VirtualNetworkGatewayConnectionsSetSharedKeyResponse

VirtualNetworkGatewayConnectionsSetSharedKeyResponse: ConnectionSharedKey & object

Contains response data for the setSharedKey operation.

VirtualNetworkGatewayConnectionsUpdateTagsResponse

VirtualNetworkGatewayConnectionsUpdateTagsResponse: VirtualNetworkGatewayConnectionListEntity & object

Contains response data for the updateTags operation.

VirtualNetworkGatewaySkuName

VirtualNetworkGatewaySkuName: "Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3"

Defines values for VirtualNetworkGatewaySkuName. Possible values include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3'

readonly
enum

{string}

VirtualNetworkGatewaySkuTier

VirtualNetworkGatewaySkuTier: "Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3"

Defines values for VirtualNetworkGatewaySkuTier. Possible values include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3'

readonly
enum

{string}

VirtualNetworkGatewayType

VirtualNetworkGatewayType: "Vpn" | "ExpressRoute"

Defines values for VirtualNetworkGatewayType. Possible values include: 'Vpn', 'ExpressRoute'

readonly
enum

{string}

VirtualNetworkGatewaysBeginCreateOrUpdateResponse

VirtualNetworkGatewaysBeginCreateOrUpdateResponse: VirtualNetworkGateway & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworkGatewaysBeginGeneratevpnclientpackageResponse

VirtualNetworkGatewaysBeginGeneratevpnclientpackageResponse: object

Contains response data for the beginGeneratevpnclientpackage operation.

Type declaration

VirtualNetworkGatewaysBeginGetAdvertisedRoutesResponse

VirtualNetworkGatewaysBeginGetAdvertisedRoutesResponse: GatewayRouteListResult & object

Contains response data for the beginGetAdvertisedRoutes operation.

VirtualNetworkGatewaysBeginGetBgpPeerStatusResponse

VirtualNetworkGatewaysBeginGetBgpPeerStatusResponse: BgpPeerStatusListResult & object

Contains response data for the beginGetBgpPeerStatus operation.

VirtualNetworkGatewaysBeginGetLearnedRoutesResponse

VirtualNetworkGatewaysBeginGetLearnedRoutesResponse: GatewayRouteListResult & object

Contains response data for the beginGetLearnedRoutes operation.

VirtualNetworkGatewaysBeginGetVpnProfilePackageUrlResponse

VirtualNetworkGatewaysBeginGetVpnProfilePackageUrlResponse: object

Contains response data for the beginGetVpnProfilePackageUrl operation.

Type declaration

VirtualNetworkGatewaysBeginResetResponse

VirtualNetworkGatewaysBeginResetResponse: VirtualNetworkGateway & object

Contains response data for the beginReset operation.

VirtualNetworkGatewaysBeginUpdateTagsResponse

VirtualNetworkGatewaysBeginUpdateTagsResponse: VirtualNetworkGateway & object

Contains response data for the beginUpdateTags operation.

VirtualNetworkGatewaysCreateOrUpdateResponse

VirtualNetworkGatewaysCreateOrUpdateResponse: VirtualNetworkGateway & object

Contains response data for the createOrUpdate operation.

VirtualNetworkGatewaysGenerateVpnProfileResponse

VirtualNetworkGatewaysGenerateVpnProfileResponse: object

Contains response data for the generateVpnProfile operation.

Type declaration

VirtualNetworkGatewaysGeneratevpnclientpackageResponse

VirtualNetworkGatewaysGeneratevpnclientpackageResponse: object

Contains response data for the generatevpnclientpackage operation.

Type declaration

VirtualNetworkGatewaysGetAdvertisedRoutesResponse

VirtualNetworkGatewaysGetAdvertisedRoutesResponse: GatewayRouteListResult & object

Contains response data for the getAdvertisedRoutes operation.

VirtualNetworkGatewaysGetBgpPeerStatusResponse

VirtualNetworkGatewaysGetBgpPeerStatusResponse: BgpPeerStatusListResult & object

Contains response data for the getBgpPeerStatus operation.

VirtualNetworkGatewaysGetLearnedRoutesResponse

VirtualNetworkGatewaysGetLearnedRoutesResponse: GatewayRouteListResult & object

Contains response data for the getLearnedRoutes operation.

VirtualNetworkGatewaysGetResponse

VirtualNetworkGatewaysGetResponse: VirtualNetworkGateway & object

Contains response data for the get operation.

VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse

VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse: object

Contains response data for the getVpnProfilePackageUrl operation.

Type declaration

VirtualNetworkGatewaysListConnectionsNextResponse

VirtualNetworkGatewaysListConnectionsNextResponse: VirtualNetworkGatewayListConnectionsResult & object

Contains response data for the listConnectionsNext operation.

VirtualNetworkGatewaysListConnectionsResponse

VirtualNetworkGatewaysListConnectionsResponse: VirtualNetworkGatewayListConnectionsResult & object

Contains response data for the listConnections operation.

VirtualNetworkGatewaysListNextResponse

VirtualNetworkGatewaysListNextResponse: VirtualNetworkGatewayListResult & object

Contains response data for the listNext operation.

VirtualNetworkGatewaysListResponse

VirtualNetworkGatewaysListResponse: VirtualNetworkGatewayListResult & object

Contains response data for the list operation.

VirtualNetworkGatewaysResetResponse

VirtualNetworkGatewaysResetResponse: VirtualNetworkGateway & object

Contains response data for the reset operation.

VirtualNetworkGatewaysSupportedVpnDevicesResponse

VirtualNetworkGatewaysSupportedVpnDevicesResponse: object

Contains response data for the supportedVpnDevices operation.

Type declaration

VirtualNetworkGatewaysUpdateTagsResponse

VirtualNetworkGatewaysUpdateTagsResponse: VirtualNetworkGateway & object

Contains response data for the updateTags operation.

VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse

VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse: object

Contains response data for the vpnDeviceConfigurationScript operation.

Type declaration

VirtualNetworkPeeringState

VirtualNetworkPeeringState: "Initiated" | "Connected" | "Disconnected"

Defines values for VirtualNetworkPeeringState. Possible values include: 'Initiated', 'Connected', 'Disconnected'

readonly
enum

{string}

VirtualNetworkPeeringsBeginCreateOrUpdateResponse

VirtualNetworkPeeringsBeginCreateOrUpdateResponse: VirtualNetworkPeering & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworkPeeringsCreateOrUpdateResponse

VirtualNetworkPeeringsCreateOrUpdateResponse: VirtualNetworkPeering & object

Contains response data for the createOrUpdate operation.

VirtualNetworkPeeringsGetResponse

VirtualNetworkPeeringsGetResponse: VirtualNetworkPeering & object

Contains response data for the get operation.

VirtualNetworkPeeringsListNextResponse

VirtualNetworkPeeringsListNextResponse: VirtualNetworkPeeringListResult & object

Contains response data for the listNext operation.

VirtualNetworkPeeringsListResponse

VirtualNetworkPeeringsListResponse: VirtualNetworkPeeringListResult & object

Contains response data for the list operation.

VirtualNetworksBeginCreateOrUpdateResponse

VirtualNetworksBeginCreateOrUpdateResponse: VirtualNetwork & object

Contains response data for the beginCreateOrUpdate operation.

VirtualNetworksBeginUpdateTagsResponse

VirtualNetworksBeginUpdateTagsResponse: VirtualNetwork & object

Contains response data for the beginUpdateTags operation.

VirtualNetworksCheckIPAddressAvailabilityResponse

VirtualNetworksCheckIPAddressAvailabilityResponse: IPAddressAvailabilityResult & object

Contains response data for the checkIPAddressAvailability operation.

VirtualNetworksCreateOrUpdateResponse

VirtualNetworksCreateOrUpdateResponse: VirtualNetwork & object

Contains response data for the createOrUpdate operation.

VirtualNetworksGetResponse

VirtualNetworksGetResponse: VirtualNetwork & object

Contains response data for the get operation.

VirtualNetworksListAllNextResponse

VirtualNetworksListAllNextResponse: VirtualNetworkListResult & object

Contains response data for the listAllNext operation.

VirtualNetworksListAllResponse

VirtualNetworksListAllResponse: VirtualNetworkListResult & object

Contains response data for the listAll operation.

VirtualNetworksListNextResponse

VirtualNetworksListNextResponse: VirtualNetworkListResult & object

Contains response data for the listNext operation.

VirtualNetworksListResponse

VirtualNetworksListResponse: VirtualNetworkListResult & object

Contains response data for the list operation.

VirtualNetworksListUsageNextResponse

VirtualNetworksListUsageNextResponse: VirtualNetworkListUsageResult & object

Contains response data for the listUsageNext operation.

VirtualNetworksListUsageResponse

VirtualNetworksListUsageResponse: VirtualNetworkListUsageResult & object

Contains response data for the listUsage operation.

VirtualNetworksUpdateTagsResponse

VirtualNetworksUpdateTagsResponse: VirtualNetwork & object

Contains response data for the updateTags operation.

VpnClientProtocol

VpnClientProtocol: "IkeV2" | "SSTP"

Defines values for VpnClientProtocol. Possible values include: 'IkeV2', 'SSTP'

readonly
enum

{string}

VpnType

VpnType: "PolicyBased" | "RouteBased"

Defines values for VpnType. Possible values include: 'PolicyBased', 'RouteBased'

readonly
enum

{string}

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AddressSpace

AddressSpace: object

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

Optional addressPrefixes

addressPrefixes: string[]

A list of address blocks reserved for this virtual network in CIDR notation.

serializedName

serializedName: string = "AddressSpace"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefixes

addressPrefixes: object

serializedName

serializedName: string = "addressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayBackendAddress

ApplicationGatewayBackendAddress: object

Backend address of an application gateway.

Optional fqdn

fqdn: undefined | string

Fully qualified domain name (FQDN).

Optional ipAddress

ipAddress: undefined | string

IP address

serializedName

serializedName: string = "ApplicationGatewayBackendAddress"

type

type: object

className

className: string = "ApplicationGatewayBackendAddress"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fqdn

fqdn: object

serializedName

serializedName: string = "fqdn"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

Const ApplicationGatewayBackendAddressPool

ApplicationGatewayBackendAddressPool: object

Backend Address Pool of an application gateway.

Optional backendAddresses

backendAddresses: ApplicationGatewayBackendAddress[]

Backend addresses

Optional backendIPConfigurations

backendIPConfigurations: NetworkInterfaceIPConfiguration[]

Collection of references to IPs defined in network interfaces.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

Resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "ApplicationGatewayBackendAddressPool"

type

type: object

Type of the resource.

className

className: string = "ApplicationGatewayBackendAddressPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddresses

backendAddresses: object

serializedName

serializedName: string = "properties.backendAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayBackendAddress"

name

name: "Composite" = "Composite"

backendIPConfigurations

backendIPConfigurations: object

serializedName

serializedName: string = "properties.backendIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApplicationSecurityGroup

ApplicationSecurityGroup: object

An application security group in a resource group.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApplicationSecurityGroup"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "ApplicationSecurityGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

Const Availability

Availability: object

Availability of the metric.

Optional blobDuration

blobDuration: undefined | string

Duration of the availability blob.

Optional retention

retention: undefined | string

The retention of the availability.

serializedName

serializedName: string = "Availability"

Optional timeGrain

timeGrain: undefined | string

The time grain of the availability.

type

type: object

className

className: string = "Availability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

name: "String" = "String"

retention

retention: object

serializedName

serializedName: string = "retention"

type

type: object

name

name: "String" = "String"

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

Const AzureAsyncOperationResult

AzureAsyncOperationResult: object

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Optional error

error: ErrorModel

serializedName

serializedName: string = "AzureAsyncOperationResult"

Optional status

Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and 'Failed'. Possible values include: 'InProgress', 'Succeeded', 'Failed'

type

type: object

className

className: string = "AzureAsyncOperationResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const BackendAddressPool

BackendAddressPool: object

Pool of backend IP addresses.

Optional backendIPConfigurations

backendIPConfigurations: NetworkInterfaceIPConfiguration[]

Gets collection of references to IP addresses defined in network interfaces. NOTE: This property will not be serialized. It can only be populated by the server.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional loadBalancingRules

loadBalancingRules: SubResource[]

Gets load balancing rules that use this backend address pool. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional outboundNatRule

outboundNatRule: SubResource

Gets outbound rules that use this backend address pool. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "BackendAddressPool"

type

type: object

className

className: string = "BackendAddressPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendIPConfigurations

backendIPConfigurations: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.backendIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

loadBalancingRules

loadBalancingRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.loadBalancingRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

outboundNatRule

outboundNatRule: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outboundNatRule"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const BgpPeerStatus

BgpPeerStatus: object

BGP peer status details

Optional asn

asn: undefined | number

The autonomous system number of the remote BGP peer NOTE: This property will not be serialized. It can only be populated by the server.

Optional connectedDuration

connectedDuration: undefined | string

For how long the peering has been up NOTE: This property will not be serialized. It can only be populated by the server.

Optional localAddress

localAddress: undefined | string

The virtual network gateway's local address NOTE: This property will not be serialized. It can only be populated by the server.

Optional messagesReceived

messagesReceived: undefined | number

The number of BGP messages received NOTE: This property will not be serialized. It can only be populated by the server.

Optional messagesSent

messagesSent: undefined | number

The number of BGP messages sent NOTE: This property will not be serialized. It can only be populated by the server.

Optional neighbor

neighbor: undefined | string

The remote BGP peer NOTE: This property will not be serialized. It can only be populated by the server.

Optional routesReceived

routesReceived: undefined | number

The number of routes learned from this peer NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BgpPeerStatus"

Optional state

The BGP peer state. Possible values include: 'Unknown', 'Stopped', 'Idle', 'Connecting', 'Connected' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "BgpPeerStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

asn

asn: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "asn"

type

type: object

name

name: "Number" = "Number"

connectedDuration

connectedDuration: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "connectedDuration"

type

type: object

name

name: "String" = "String"

localAddress

localAddress: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "localAddress"

type

type: object

name

name: "String" = "String"

messagesReceived

messagesReceived: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "messagesReceived"

type

type: object

name

name: "Number" = "Number"

messagesSent

messagesSent: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "messagesSent"

type

type: object

name

name: "Number" = "Number"

neighbor

neighbor: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "neighbor"

type

type: object

name

name: "String" = "String"

routesReceived

routesReceived: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "routesReceived"

type

type: object

name

name: "Number" = "Number"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const BgpPeerStatusListResult

BgpPeerStatusListResult: object

Response for list BGP peer status API service call

serializedName

serializedName: string = "BgpPeerStatusListResult"

Optional value

value: BgpPeerStatus[]

List of BGP peers

type

type: object

className

className: string = "BgpPeerStatusListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BgpPeerStatus"

name

name: "Composite" = "Composite"

Const BgpSettings

BgpSettings: object

BGP settings details

Optional asn

asn: undefined | number

The BGP speaker's ASN.

Optional bgpPeeringAddress

bgpPeeringAddress: undefined | string

The BGP peering address and BGP identifier of this BGP speaker.

Optional peerWeight

peerWeight: undefined | number

The weight added to routes learned from this BGP speaker.

serializedName

serializedName: string = "BgpSettings"

type

type: object

className

className: string = "BgpSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

asn

asn: object

serializedName

serializedName: string = "asn"

type

type: object

name

name: "Number" = "Number"

bgpPeeringAddress

bgpPeeringAddress: object

serializedName

serializedName: string = "bgpPeeringAddress"

type

type: object

name

name: "String" = "String"

peerWeight

peerWeight: object

serializedName

serializedName: string = "peerWeight"

type

type: object

name

name: "Number" = "Number"

Const ConnectionResetSharedKey

ConnectionResetSharedKey: object

The virtual network connection reset shared key

keyLength

keyLength: number

The virtual network connection reset shared key length, should between 1 and 128.

serializedName

serializedName: string = "ConnectionResetSharedKey"

type

type: object

className

className: string = "ConnectionResetSharedKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyLength

keyLength: object

required

required: true = true

serializedName

serializedName: string = "keyLength"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 128

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const ConnectionSharedKey

ConnectionSharedKey: object

Response for GetConnectionSharedKey API service call

serializedName

serializedName: string = "ConnectionSharedKey"

value

value: string

The virtual network connection shared key value.

type

type: object

className

className: string = "ConnectionSharedKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const DhcpOptions

DhcpOptions: object

DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.

Optional dnsServers

dnsServers: string[]

The list of DNS servers IP addresses.

serializedName

serializedName: string = "DhcpOptions"

type

type: object

className

className: string = "DhcpOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dnsServers

dnsServers: object

serializedName

serializedName: string = "dnsServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const Dimension

Dimension: object

Dimension of the metric.

Optional displayName

displayName: undefined | string

The display name of the dimension.

Optional internalName

internalName: undefined | string

The internal name of the dimension.

Optional name

name: undefined | string

The name of the dimension.

serializedName

serializedName: string = "Dimension"

type

type: object

className

className: string = "Dimension"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

internalName

internalName: object

serializedName

serializedName: string = "internalName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const EffectiveNetworkSecurityGroup

EffectiveNetworkSecurityGroup: object

Effective network security group.

Optional association

Associated resources.

Optional effectiveSecurityRules

effectiveSecurityRules: EffectiveNetworkSecurityRule[]

A collection of effective security rules.

Optional networkSecurityGroup

networkSecurityGroup: SubResource

The ID of network security group that is applied.

serializedName

serializedName: string = "EffectiveNetworkSecurityGroup"

Optional tagMap

tagMap: undefined | object

Mapping of tags to list of IP Addresses included within the tag.

type

type: object

className

className: string = "EffectiveNetworkSecurityGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

association

association: object

serializedName

serializedName: string = "association"

type

type: object

className

className: string = "EffectiveNetworkSecurityGroupAssociation"

name

name: "Composite" = "Composite"

effectiveSecurityRules

effectiveSecurityRules: object

serializedName

serializedName: string = "effectiveSecurityRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EffectiveNetworkSecurityRule"

name

name: "Composite" = "Composite"

networkSecurityGroup

networkSecurityGroup: object

serializedName

serializedName: string = "networkSecurityGroup"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

tagMap

tagMap: object

serializedName

serializedName: string = "tagMap"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const EffectiveNetworkSecurityGroupAssociation

EffectiveNetworkSecurityGroupAssociation: object

The effective network security group association.

Optional networkInterface

networkInterface: SubResource

The ID of the network interface if assigned.

serializedName

serializedName: string = "EffectiveNetworkSecurityGroupAssociation"

Optional subnet

subnet: SubResource

The ID of the subnet if assigned.

type

type: object

className

className: string = "EffectiveNetworkSecurityGroupAssociation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

networkInterface

networkInterface: object

serializedName

serializedName: string = "networkInterface"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "subnet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const EffectiveNetworkSecurityGroupListResult

EffectiveNetworkSecurityGroupListResult: object

Response for list effective network security groups API service call.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "EffectiveNetworkSecurityGroupListResult"

Optional value

value: EffectiveNetworkSecurityGroup[]

A list of effective network security groups.

type

type: object

className

className: string = "EffectiveNetworkSecurityGroupListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EffectiveNetworkSecurityGroup"

name

name: "Composite" = "Composite"

Const EffectiveNetworkSecurityRule

EffectiveNetworkSecurityRule: object

Effective network security rules.

Optional access

Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. Possible values include: 'Allow', 'Deny'

Optional destinationAddressPrefix

destinationAddressPrefix: undefined | string

The destination address prefix.

Optional destinationAddressPrefixes

destinationAddressPrefixes: string[]

The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*).

Optional destinationPortRange

destinationPortRange: undefined | string

The destination port or range.

Optional destinationPortRanges

destinationPortRanges: string[]

The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)

Optional direction

The direction of the rule. Possible values are: 'Inbound and Outbound'. Possible values include: 'Inbound', 'Outbound'

Optional expandedDestinationAddressPrefix

expandedDestinationAddressPrefix: string[]

Expanded destination address prefix.

Optional expandedSourceAddressPrefix

expandedSourceAddressPrefix: string[]

The expanded source address prefix.

Optional name

name: undefined | string

The name of the security rule specified by the user (if created by the user).

Optional priority

priority: undefined | number

The priority of the rule.

Optional protocol

The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and 'All'. Possible values include: 'Tcp', 'Udp', 'All'

serializedName

serializedName: string = "EffectiveNetworkSecurityRule"

Optional sourceAddressPrefix

sourceAddressPrefix: undefined | string

The source address prefix.

Optional sourceAddressPrefixes

sourceAddressPrefixes: string[]

The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*).

Optional sourcePortRange

sourcePortRange: undefined | string

The source port or range.

Optional sourcePortRanges

sourcePortRanges: string[]

The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)

type

type: object

className

className: string = "EffectiveNetworkSecurityRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

access

access: object

serializedName

serializedName: string = "access"

type

type: object

name

name: "String" = "String"

destinationAddressPrefix

destinationAddressPrefix: object

serializedName

serializedName: string = "destinationAddressPrefix"

type

type: object

name

name: "String" = "String"

destinationAddressPrefixes

destinationAddressPrefixes: object

serializedName

serializedName: string = "destinationAddressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

destinationPortRange

destinationPortRange: object

serializedName

serializedName: string = "destinationPortRange"

type

type: object

name

name: "String" = "String"

destinationPortRanges

destinationPortRanges: object

serializedName

serializedName: string = "destinationPortRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

direction

direction: object

serializedName

serializedName: string = "direction"

type

type: object

name

name: "String" = "String"

expandedDestinationAddressPrefix

expandedDestinationAddressPrefix: object

serializedName

serializedName: string = "expandedDestinationAddressPrefix"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

expandedSourceAddressPrefix

expandedSourceAddressPrefix: object

serializedName

serializedName: string = "expandedSourceAddressPrefix"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

priority

priority: object

serializedName

serializedName: string = "priority"

type

type: object

name

name: "Number" = "Number"

protocol

protocol: object

serializedName

serializedName: string = "protocol"

type

type: object

name

name: "String" = "String"

sourceAddressPrefix

sourceAddressPrefix: object

serializedName

serializedName: string = "sourceAddressPrefix"

type

type: object

name

name: "String" = "String"

sourceAddressPrefixes

sourceAddressPrefixes: object

serializedName

serializedName: string = "sourceAddressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

sourcePortRange

sourcePortRange: object

serializedName

serializedName: string = "sourcePortRange"

type

type: object

name

name: "String" = "String"

sourcePortRanges

sourcePortRanges: object

serializedName

serializedName: string = "sourcePortRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const EffectiveRoute

EffectiveRoute: object

Effective Route

Optional addressPrefix

addressPrefix: string[]

The address prefixes of the effective routes in CIDR notation.

Optional name

name: undefined | string

The name of the user defined route. This is optional.

Optional nextHopIpAddress

nextHopIpAddress: string[]

The IP address of the next hop of the effective route.

Optional nextHopType

nextHopType: RouteNextHopType

The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. Possible values include: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', 'None'

serializedName

serializedName: string = "EffectiveRoute"

Optional source

Who created the route. Possible values are: 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'. Possible values include: 'Unknown', 'User', 'VirtualNetworkGateway', 'Default'

Optional state

The value of effective route. Possible values are: 'Active' and 'Invalid'. Possible values include: 'Active', 'Invalid'

type

type: object

className

className: string = "EffectiveRoute"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefix

addressPrefix: object

serializedName

serializedName: string = "addressPrefix"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

nextHopIpAddress

nextHopIpAddress: object

serializedName

serializedName: string = "nextHopIpAddress"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

nextHopType

nextHopType: object

serializedName

serializedName: string = "nextHopType"

type

type: object

name

name: "String" = "String"

source

source: object

serializedName

serializedName: string = "source"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const EffectiveRouteListResult

EffectiveRouteListResult: object

Response for list effective route API service call.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "EffectiveRouteListResult"

Optional value

value: EffectiveRoute[]

A list of effective routes.

type

type: object

className

className: string = "EffectiveRouteListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EffectiveRoute"

name

name: "Composite" = "Composite"

Const ErrorDetails

ErrorDetails: object

An interface representing ErrorDetails.

Optional code

code: undefined | string

Optional message

message: undefined | string

serializedName

serializedName: string = "ErrorDetails"

Optional target

target: undefined | string

type

type: object

className

className: string = "ErrorDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

Const ErrorModel

ErrorModel: object

An interface representing ErrorModel.

Optional code

code: undefined | string

Optional details

details: ErrorDetails[]

Optional innerError

innerError: undefined | string

Optional message

message: undefined | string

serializedName

serializedName: string = "Error"

Optional target

target: undefined | string

type

type: object

className

className: string = "ErrorModel"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorDetails"

name

name: "Composite" = "Composite"

innerError

innerError: object

serializedName

serializedName: string = "innerError"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

Const FrontendIPConfiguration

FrontendIPConfiguration: object

Frontend IP address of the load balancer.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional inboundNatPools

inboundNatPools: SubResource[]

Read only. Inbound pools URIs that use this frontend IP. NOTE: This property will not be serialized. It can only be populated by the server.

Optional inboundNatRules

inboundNatRules: SubResource[]

Read only. Inbound rules URIs that use this frontend IP. NOTE: This property will not be serialized. It can only be populated by the server.

Optional loadBalancingRules

loadBalancingRules: SubResource[]

Gets load balancing rules URIs that use this frontend IP. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional outboundNatRules

outboundNatRules: SubResource[]

Read only. Outbound rules URIs that use this frontend IP. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateIPAddress

privateIPAddress: undefined | string

The private IP address of the IP configuration.

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddress

publicIPAddress: PublicIPAddress

The reference of the Public IP resource.

serializedName

serializedName: string = "FrontendIPConfiguration"

Optional subnet

subnet: Subnet

The reference of the subnet resource.

Optional zones

zones: string[]

A list of availability zones denoting the IP allocated for the resource needs to come from.

type

type: object

className

className: string = "FrontendIPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

inboundNatPools

inboundNatPools: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.inboundNatPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

inboundNatRules

inboundNatRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.inboundNatRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

loadBalancingRules

loadBalancingRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.loadBalancingRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

outboundNatRules

outboundNatRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outboundNatRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

privateIPAddress

privateIPAddress: object

serializedName

serializedName: string = "properties.privateIPAddress"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

zones

zones: object

serializedName

serializedName: string = "zones"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const GatewayRoute

GatewayRoute: object

Gateway routing details

Optional asPath

asPath: undefined | string

The route's AS path sequence NOTE: This property will not be serialized. It can only be populated by the server.

Optional localAddress

localAddress: undefined | string

The gateway's local address NOTE: This property will not be serialized. It can only be populated by the server.

Optional network

network: undefined | string

The route's network prefix NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextHop

nextHop: undefined | string

The route's next hop NOTE: This property will not be serialized. It can only be populated by the server.

Optional origin

origin: undefined | string

The source this route was learned from NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "GatewayRoute"

Optional sourcePeer

sourcePeer: undefined | string

The peer this route was learned from NOTE: This property will not be serialized. It can only be populated by the server.

Optional weight

weight: undefined | number

The route's weight NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "GatewayRoute"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

asPath

asPath: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "asPath"

type

type: object

name

name: "String" = "String"

localAddress

localAddress: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "localAddress"

type

type: object

name

name: "String" = "String"

network

network: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "network"

type

type: object

name

name: "String" = "String"

nextHop

nextHop: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextHop"

type

type: object

name

name: "String" = "String"

origin

origin: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

sourcePeer

sourcePeer: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "sourcePeer"

type

type: object

name

name: "String" = "String"

weight

weight: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "weight"

type

type: object

name

name: "Number" = "Number"

Const GatewayRouteListResult

GatewayRouteListResult: object

List of virtual network gateway routes

serializedName

serializedName: string = "GatewayRouteListResult"

Optional value

value: GatewayRoute[]

List of gateway routes

type

type: object

className

className: string = "GatewayRouteListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GatewayRoute"

name

name: "Composite" = "Composite"

Const IPAddressAvailabilityResult

IPAddressAvailabilityResult: object

Response for CheckIPAddressAvailability API service call

Optional available

available: undefined | false | true

Private IP address availability.

Optional availableIPAddresses

availableIPAddresses: string[]

Contains other available private IP addresses if the asked for address is taken.

serializedName

serializedName: string = "IPAddressAvailabilityResult"

type

type: object

className

className: string = "IPAddressAvailabilityResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

available

available: object

serializedName

serializedName: string = "available"

type

type: object

name

name: "Boolean" = "Boolean"

availableIPAddresses

availableIPAddresses: object

serializedName

serializedName: string = "availableIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const IPConfiguration

IPConfiguration: object

IP configuration

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional privateIPAddress

privateIPAddress: undefined | string

The private IP address of the IP configuration.

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

The private IP allocation method. Possible values are 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddress

publicIPAddress: PublicIPAddress

The reference of the public IP resource.

serializedName

serializedName: string = "IPConfiguration"

Optional subnet

subnet: Subnet

The reference of the subnet resource.

type

type: object

className

className: string = "IPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

privateIPAddress

privateIPAddress: object

serializedName

serializedName: string = "properties.privateIPAddress"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const InboundNatPool

InboundNatPool: object

Inbound NAT pool of the load balancer.

backendPort

backendPort: number

The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional frontendIPConfiguration

frontendIPConfiguration: SubResource

A reference to frontend IP addresses.

frontendPortRangeEnd

frontendPortRangeEnd: number

The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.

frontendPortRangeStart

frontendPortRangeStart: number

The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

protocol

Possible values include: 'Udp', 'Tcp', 'All'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "InboundNatPool"

type

type: object

className

className: string = "InboundNatPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendPort

backendPort: object

required

required: true = true

serializedName

serializedName: string = "properties.backendPort"

type

type: object

name

name: "Number" = "Number"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfiguration

frontendIPConfiguration: object

serializedName

serializedName: string = "properties.frontendIPConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

frontendPortRangeEnd

frontendPortRangeEnd: object

required

required: true = true

serializedName

serializedName: string = "properties.frontendPortRangeEnd"

type

type: object

name

name: "Number" = "Number"

frontendPortRangeStart

frontendPortRangeStart: object

required

required: true = true

serializedName

serializedName: string = "properties.frontendPortRangeStart"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const InboundNatRule

InboundNatRule: object

Inbound NAT rule of the load balancer.

Optional backendIPConfiguration

backendIPConfiguration: NetworkInterfaceIPConfiguration

A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP. NOTE: This property will not be serialized. It can only be populated by the server.

Optional backendPort

backendPort: undefined | number

The port used for the internal endpoint. Acceptable values range from 1 to 65535.

Optional enableFloatingIP

enableFloatingIP: undefined | false | true

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional frontendIPConfiguration

frontendIPConfiguration: SubResource

A reference to frontend IP addresses.

Optional frontendPort

frontendPort: undefined | number

The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.

Optional id

id: undefined | string

Resource ID.

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional protocol

Possible values include: 'Udp', 'Tcp', 'All'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "InboundNatRule"

type

type: object

className

className: string = "InboundNatRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendIPConfiguration

backendIPConfiguration: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.backendIPConfiguration"

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

backendPort

backendPort: object

serializedName

serializedName: string = "properties.backendPort"

type

type: object

name

name: "Number" = "Number"

enableFloatingIP

enableFloatingIP: object

serializedName

serializedName: string = "properties.enableFloatingIP"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfiguration

frontendIPConfiguration: object

serializedName

serializedName: string = "properties.frontendIPConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

frontendPort

frontendPort: object

serializedName

serializedName: string = "properties.frontendPort"

type

type: object

name

name: "Number" = "Number"

idleTimeoutInMinutes

idleTimeoutInMinutes: object

serializedName

serializedName: string = "properties.idleTimeoutInMinutes"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocol

protocol: object

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const InboundNatRuleListResult

InboundNatRuleListResult: object
interface

Response for ListInboundNatRule API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "InboundNatRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<InboundNatRule>
  • Iterator

    Returns IterableIterator<InboundNatRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<InboundNatRule>[]): InboundNatRule[]
  • concat(...items: (T | ConcatArray<T>)[]): InboundNatRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<InboundNatRule>[]

      Additional items to add to the end of array1.

    Returns InboundNatRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns InboundNatRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, InboundNatRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, InboundNatRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): boolean
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: InboundNatRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: InboundNatRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): InboundNatRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: InboundNatRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): boolean
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): any
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns InboundNatRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): InboundNatRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: InboundNatRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: InboundNatRule, index: number, obj: InboundNatRule[]): boolean
        • Parameters

          • this: void
          • value: InboundNatRule
          • index: number
          • obj: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: InboundNatRule, index: number, obj: InboundNatRule[]): boolean
        • Parameters

          • value: InboundNatRule
          • index: number
          • obj: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

    Returns InboundNatRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: InboundNatRule, index: number, obj: InboundNatRule[]): boolean
        • Parameters

          • value: InboundNatRule
          • index: number
          • obj: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): void
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: InboundNatRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: InboundNatRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: InboundNatRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: InboundNatRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: InboundNatRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: InboundNatRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): U
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): InboundNatRule | undefined
  • Removes the last element from an array and returns it.

    Returns InboundNatRule | undefined

push

  • push(...items: InboundNatRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: InboundNatRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): InboundNatRule
  • reduce(callbackfn: function, initialValue: InboundNatRule): InboundNatRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: InboundNatRule, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): InboundNatRule
        • Parameters

          • previousValue: InboundNatRule
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns InboundNatRule

    Returns InboundNatRule

  • Parameters

    • callbackfn: function
        • (previousValue: InboundNatRule, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): InboundNatRule
        • Parameters

          • previousValue: InboundNatRule
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns InboundNatRule

    • initialValue: InboundNatRule

    Returns InboundNatRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): InboundNatRule
  • reduceRight(callbackfn: function, initialValue: InboundNatRule): InboundNatRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: InboundNatRule, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): InboundNatRule
        • Parameters

          • previousValue: InboundNatRule
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns InboundNatRule

    Returns InboundNatRule

  • Parameters

    • callbackfn: function
        • (previousValue: InboundNatRule, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): InboundNatRule
        • Parameters

          • previousValue: InboundNatRule
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns InboundNatRule

    • initialValue: InboundNatRule

    Returns InboundNatRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: InboundNatRule, currentIndex: number, array: InboundNatRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: InboundNatRule
          • currentIndex: number
          • array: InboundNatRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): InboundNatRule[]
  • Reverses the elements in an Array.

    Returns InboundNatRule[]

shift

  • shift(): InboundNatRule | undefined
  • Removes the first element from an array and returns it.

    Returns InboundNatRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): InboundNatRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns InboundNatRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: InboundNatRule, index: number, array: InboundNatRule[]): boolean
        • Parameters

          • value: InboundNatRule
          • index: number
          • array: InboundNatRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): InboundNatRule[]
  • splice(start: number, deleteCount: number, ...items: InboundNatRule[]): InboundNatRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns InboundNatRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: InboundNatRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns InboundNatRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: InboundNatRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: InboundNatRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<InboundNatRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<InboundNatRule>

type

type: object

className

className: string = "InboundNatRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNatRule"

name

name: "Composite" = "Composite"

Const IpsecPolicy

IpsecPolicy: object

An IPSec Policy configuration for a virtual network gateway connection

dhGroup

dhGroup: DhGroup

The DH Groups used in IKE Phase 1 for initial SA. Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24'

ikeEncryption

ikeEncryption: IkeEncryption

The IKE encryption algorithm (IKE phase 2). Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256'

ikeIntegrity

ikeIntegrity: IkeIntegrity

The IKE integrity algorithm (IKE phase 2). Possible values include: 'MD5', 'SHA1', 'SHA256', 'SHA384'

ipsecEncryption

ipsecEncryption: IpsecEncryption

The IPSec encryption algorithm (IKE phase 1). Possible values include: 'None', 'DES', 'DES3', 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256'

ipsecIntegrity

ipsecIntegrity: IpsecIntegrity

The IPSec integrity algorithm (IKE phase 1). Possible values include: 'MD5', 'SHA1', 'SHA256', 'GCMAES128', 'GCMAES192', 'GCMAES256'

pfsGroup

pfsGroup: PfsGroup

The DH Groups used in IKE Phase 2 for new child SA. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', 'ECP256', 'ECP384', 'PFS24'

saDataSizeKilobytes

saDataSizeKilobytes: number

The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.

saLifeTimeSeconds

saLifeTimeSeconds: number

The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

serializedName

serializedName: string = "IpsecPolicy"

type

type: object

className

className: string = "IpsecPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dhGroup

dhGroup: object

required

required: true = true

serializedName

serializedName: string = "dhGroup"

type

type: object

name

name: "String" = "String"

ikeEncryption

ikeEncryption: object

required

required: true = true

serializedName

serializedName: string = "ikeEncryption"

type

type: object

name

name: "String" = "String"

ikeIntegrity

ikeIntegrity: object

required

required: true = true

serializedName

serializedName: string = "ikeIntegrity"

type

type: object

name

name: "String" = "String"

ipsecEncryption

ipsecEncryption: object

required

required: true = true

serializedName

serializedName: string = "ipsecEncryption"

type

type: object

name

name: "String" = "String"

ipsecIntegrity

ipsecIntegrity: object

required

required: true = true

serializedName

serializedName: string = "ipsecIntegrity"

type

type: object

name

name: "String" = "String"

pfsGroup

pfsGroup: object

required

required: true = true

serializedName

serializedName: string = "pfsGroup"

type

type: object

name

name: "String" = "String"

saDataSizeKilobytes

saDataSizeKilobytes: object

required

required: true = true

serializedName

serializedName: string = "saDataSizeKilobytes"

type

type: object

name

name: "Number" = "Number"

saLifeTimeSeconds

saLifeTimeSeconds: object

required

required: true = true

serializedName

serializedName: string = "saLifeTimeSeconds"

type

type: object

name

name: "Number" = "Number"

Const LoadBalancer

LoadBalancer: object

LoadBalancer resource

Optional backendAddressPools

backendAddressPools: BackendAddressPool[]

Collection of backend address pools used by a load balancer

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional frontendIPConfigurations

frontendIPConfigurations: FrontendIPConfiguration[]

Object representing the frontend IPs to be used for the load balancer

Optional id

id: undefined | string

Resource ID.

Optional inboundNatPools

inboundNatPools: InboundNatPool[]

Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.

Optional inboundNatRules

inboundNatRules: InboundNatRule[]

Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.

Optional loadBalancingRules

loadBalancingRules: LoadBalancingRule[]

Object collection representing the load balancing rules Gets the provisioning

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outboundNatRules

outboundNatRules: OutboundNatRule[]

The outbound NAT rules.

Optional probes

probes: Probe[]

Collection of probe objects used in the load balancer

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the load balancer resource.

serializedName

serializedName: string = "LoadBalancer"

Optional sku

The load balancer SKU.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "LoadBalancer"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddressPools

backendAddressPools: object

serializedName

serializedName: string = "properties.backendAddressPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackendAddressPool"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfigurations

frontendIPConfigurations: object

serializedName

serializedName: string = "properties.frontendIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FrontendIPConfiguration"

name

name: "Composite" = "Composite"

inboundNatPools

inboundNatPools: object

serializedName

serializedName: string = "properties.inboundNatPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNatPool"

name

name: "Composite" = "Composite"

inboundNatRules

inboundNatRules: object

serializedName

serializedName: string = "properties.inboundNatRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNatRule"

name

name: "Composite" = "Composite"

loadBalancingRules

loadBalancingRules: object

serializedName

serializedName: string = "properties.loadBalancingRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadBalancingRule"

name

name: "Composite" = "Composite"

outboundNatRules

outboundNatRules: object

serializedName

serializedName: string = "properties.outboundNatRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OutboundNatRule"

name

name: "Composite" = "Composite"

probes

probes: object

serializedName

serializedName: string = "properties.probes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Probe"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "LoadBalancerSku"

name

name: "Composite" = "Composite"

Const LoadBalancerBackendAddressPoolListResult

LoadBalancerBackendAddressPoolListResult: object
interface

Response for ListBackendAddressPool API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerBackendAddressPoolListResult"

__@iterator

  • __@iterator(): IterableIterator<BackendAddressPool>
  • Iterator

    Returns IterableIterator<BackendAddressPool>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BackendAddressPool>[]): BackendAddressPool[]
  • concat(...items: (T | ConcatArray<T>)[]): BackendAddressPool[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BackendAddressPool>[]

      Additional items to add to the end of array1.

    Returns BackendAddressPool[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BackendAddressPool[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BackendAddressPool]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BackendAddressPool]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): boolean
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BackendAddressPool, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BackendAddressPool

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BackendAddressPool[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BackendAddressPool

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): boolean
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): any
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BackendAddressPool[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BackendAddressPool | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BackendAddressPool

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BackendAddressPool, index: number, obj: BackendAddressPool[]): boolean
        • Parameters

          • this: void
          • value: BackendAddressPool
          • index: number
          • obj: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BackendAddressPool, index: number, obj: BackendAddressPool[]): boolean
        • Parameters

          • value: BackendAddressPool
          • index: number
          • obj: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

    Returns BackendAddressPool | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BackendAddressPool, index: number, obj: BackendAddressPool[]): boolean
        • Parameters

          • value: BackendAddressPool
          • index: number
          • obj: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): void
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BackendAddressPool, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BackendAddressPool

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BackendAddressPool, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BackendAddressPool

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BackendAddressPool, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BackendAddressPool

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): U
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BackendAddressPool | undefined
  • Removes the last element from an array and returns it.

    Returns BackendAddressPool | undefined

push

  • push(...items: BackendAddressPool[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BackendAddressPool[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BackendAddressPool
  • reduce(callbackfn: function, initialValue: BackendAddressPool): BackendAddressPool
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackendAddressPool, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): BackendAddressPool
        • Parameters

          • previousValue: BackendAddressPool
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns BackendAddressPool

    Returns BackendAddressPool

  • Parameters

    • callbackfn: function
        • (previousValue: BackendAddressPool, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): BackendAddressPool
        • Parameters

          • previousValue: BackendAddressPool
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns BackendAddressPool

    • initialValue: BackendAddressPool

    Returns BackendAddressPool

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BackendAddressPool
  • reduceRight(callbackfn: function, initialValue: BackendAddressPool): BackendAddressPool
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackendAddressPool, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): BackendAddressPool
        • Parameters

          • previousValue: BackendAddressPool
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns BackendAddressPool

    Returns BackendAddressPool

  • Parameters

    • callbackfn: function
        • (previousValue: BackendAddressPool, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): BackendAddressPool
        • Parameters

          • previousValue: BackendAddressPool
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns BackendAddressPool

    • initialValue: BackendAddressPool

    Returns BackendAddressPool

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackendAddressPool, currentIndex: number, array: BackendAddressPool[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackendAddressPool
          • currentIndex: number
          • array: BackendAddressPool[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BackendAddressPool[]
  • Reverses the elements in an Array.

    Returns BackendAddressPool[]

shift

  • shift(): BackendAddressPool | undefined
  • Removes the first element from an array and returns it.

    Returns BackendAddressPool | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BackendAddressPool[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BackendAddressPool[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BackendAddressPool, index: number, array: BackendAddressPool[]): boolean
        • Parameters

          • value: BackendAddressPool
          • index: number
          • array: BackendAddressPool[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BackendAddressPool[]
  • splice(start: number, deleteCount: number, ...items: BackendAddressPool[]): BackendAddressPool[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BackendAddressPool[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BackendAddressPool[]

      Elements to insert into the array in place of the deleted elements.

    Returns BackendAddressPool[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BackendAddressPool[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BackendAddressPool[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BackendAddressPool>
  • Returns an iterable of values in the array

    Returns IterableIterator<BackendAddressPool>

type

type: object

className

className: string = "LoadBalancerBackendAddressPoolListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackendAddressPool"

name

name: "Composite" = "Composite"

Const LoadBalancerFrontendIPConfigurationListResult

LoadBalancerFrontendIPConfigurationListResult: object
interface

Response for ListFrontendIPConfiguration API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerFrontendIPConfigurationListResult"

__@iterator

  • __@iterator(): IterableIterator<FrontendIPConfiguration>
  • Iterator

    Returns IterableIterator<FrontendIPConfiguration>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<FrontendIPConfiguration>[]): FrontendIPConfiguration[]
  • concat(...items: (T | ConcatArray<T>)[]): FrontendIPConfiguration[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<FrontendIPConfiguration>[]

      Additional items to add to the end of array1.

    Returns FrontendIPConfiguration[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns FrontendIPConfiguration[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, FrontendIPConfiguration]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, FrontendIPConfiguration]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): boolean
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: FrontendIPConfiguration, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: FrontendIPConfiguration

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): FrontendIPConfiguration[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: FrontendIPConfiguration

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): boolean
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): any
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns FrontendIPConfiguration[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): FrontendIPConfiguration | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: FrontendIPConfiguration

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: FrontendIPConfiguration, index: number, obj: FrontendIPConfiguration[]): boolean
        • Parameters

          • this: void
          • value: FrontendIPConfiguration
          • index: number
          • obj: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: FrontendIPConfiguration, index: number, obj: FrontendIPConfiguration[]): boolean
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • obj: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

    Returns FrontendIPConfiguration | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: FrontendIPConfiguration, index: number, obj: FrontendIPConfiguration[]): boolean
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • obj: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): void
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: FrontendIPConfiguration, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: FrontendIPConfiguration

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: FrontendIPConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: FrontendIPConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: FrontendIPConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: FrontendIPConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): U
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): FrontendIPConfiguration | undefined
  • Removes the last element from an array and returns it.

    Returns FrontendIPConfiguration | undefined

push

  • push(...items: FrontendIPConfiguration[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: FrontendIPConfiguration[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): FrontendIPConfiguration
  • reduce(callbackfn: function, initialValue: FrontendIPConfiguration): FrontendIPConfiguration
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: FrontendIPConfiguration, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): FrontendIPConfiguration
        • Parameters

          • previousValue: FrontendIPConfiguration
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns FrontendIPConfiguration

    Returns FrontendIPConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: FrontendIPConfiguration, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): FrontendIPConfiguration
        • Parameters

          • previousValue: FrontendIPConfiguration
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns FrontendIPConfiguration

    • initialValue: FrontendIPConfiguration

    Returns FrontendIPConfiguration

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): FrontendIPConfiguration
  • reduceRight(callbackfn: function, initialValue: FrontendIPConfiguration): FrontendIPConfiguration
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: FrontendIPConfiguration, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): FrontendIPConfiguration
        • Parameters

          • previousValue: FrontendIPConfiguration
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns FrontendIPConfiguration

    Returns FrontendIPConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: FrontendIPConfiguration, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): FrontendIPConfiguration
        • Parameters

          • previousValue: FrontendIPConfiguration
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns FrontendIPConfiguration

    • initialValue: FrontendIPConfiguration

    Returns FrontendIPConfiguration

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FrontendIPConfiguration, currentIndex: number, array: FrontendIPConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: FrontendIPConfiguration
          • currentIndex: number
          • array: FrontendIPConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): FrontendIPConfiguration[]
  • Reverses the elements in an Array.

    Returns FrontendIPConfiguration[]

shift

  • shift(): FrontendIPConfiguration | undefined
  • Removes the first element from an array and returns it.

    Returns FrontendIPConfiguration | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): FrontendIPConfiguration[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns FrontendIPConfiguration[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: FrontendIPConfiguration, index: number, array: FrontendIPConfiguration[]): boolean
        • Parameters

          • value: FrontendIPConfiguration
          • index: number
          • array: FrontendIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): FrontendIPConfiguration[]
  • splice(start: number, deleteCount: number, ...items: FrontendIPConfiguration[]): FrontendIPConfiguration[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns FrontendIPConfiguration[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: FrontendIPConfiguration[]

      Elements to insert into the array in place of the deleted elements.

    Returns FrontendIPConfiguration[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: FrontendIPConfiguration[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: FrontendIPConfiguration[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<FrontendIPConfiguration>
  • Returns an iterable of values in the array

    Returns IterableIterator<FrontendIPConfiguration>

type

type: object

className

className: string = "LoadBalancerFrontendIPConfigurationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FrontendIPConfiguration"

name

name: "Composite" = "Composite"

Const LoadBalancerListResult

LoadBalancerListResult: object
interface

Response for ListLoadBalancers API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerListResult"

__@iterator

  • __@iterator(): IterableIterator<LoadBalancer>
  • Iterator

    Returns IterableIterator<LoadBalancer>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LoadBalancer>[]): LoadBalancer[]
  • concat(...items: (T | ConcatArray<T>)[]): LoadBalancer[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LoadBalancer>[]

      Additional items to add to the end of array1.

    Returns LoadBalancer[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LoadBalancer[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LoadBalancer]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LoadBalancer]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LoadBalancer, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LoadBalancer

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LoadBalancer[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LoadBalancer

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): any
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LoadBalancer[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LoadBalancer | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LoadBalancer

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • this: void
          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

    Returns LoadBalancer | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): void
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LoadBalancer, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LoadBalancer

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LoadBalancer, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LoadBalancer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LoadBalancer, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LoadBalancer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): U
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LoadBalancer | undefined
  • Removes the last element from an array and returns it.

    Returns LoadBalancer | undefined

push

  • push(...items: LoadBalancer[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LoadBalancer[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LoadBalancer
  • reduce(callbackfn: function, initialValue: LoadBalancer): LoadBalancer
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    Returns LoadBalancer

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    • initialValue: LoadBalancer

    Returns LoadBalancer

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LoadBalancer
  • reduceRight(callbackfn: function, initialValue: LoadBalancer): LoadBalancer
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    Returns LoadBalancer

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    • initialValue: LoadBalancer

    Returns LoadBalancer

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LoadBalancer[]
  • Reverses the elements in an Array.

    Returns LoadBalancer[]

shift

  • shift(): LoadBalancer | undefined
  • Removes the first element from an array and returns it.

    Returns LoadBalancer | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LoadBalancer[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LoadBalancer[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LoadBalancer[]
  • splice(start: number, deleteCount: number, ...items: LoadBalancer[]): LoadBalancer[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LoadBalancer[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LoadBalancer[]

      Elements to insert into the array in place of the deleted elements.

    Returns LoadBalancer[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LoadBalancer[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LoadBalancer[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LoadBalancer>
  • Returns an iterable of values in the array

    Returns IterableIterator<LoadBalancer>

type

type: object

className

className: string = "LoadBalancerListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadBalancer"

name

name: "Composite" = "Composite"

Const LoadBalancerLoadBalancingRuleListResult

LoadBalancerLoadBalancingRuleListResult: object
interface

Response for ListLoadBalancingRule API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerLoadBalancingRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<LoadBalancingRule>
  • Iterator

    Returns IterableIterator<LoadBalancingRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LoadBalancingRule>[]): LoadBalancingRule[]
  • concat(...items: (T | ConcatArray<T>)[]): LoadBalancingRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LoadBalancingRule>[]

      Additional items to add to the end of array1.

    Returns LoadBalancingRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LoadBalancingRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LoadBalancingRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LoadBalancingRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): boolean
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LoadBalancingRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LoadBalancingRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LoadBalancingRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LoadBalancingRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): boolean
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): any
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LoadBalancingRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LoadBalancingRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LoadBalancingRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LoadBalancingRule, index: number, obj: LoadBalancingRule[]): boolean
        • Parameters

          • this: void
          • value: LoadBalancingRule
          • index: number
          • obj: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LoadBalancingRule, index: number, obj: LoadBalancingRule[]): boolean
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • obj: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

    Returns LoadBalancingRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LoadBalancingRule, index: number, obj: LoadBalancingRule[]): boolean
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • obj: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): void
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LoadBalancingRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LoadBalancingRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LoadBalancingRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LoadBalancingRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LoadBalancingRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LoadBalancingRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): U
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LoadBalancingRule | undefined
  • Removes the last element from an array and returns it.

    Returns LoadBalancingRule | undefined

push

  • push(...items: LoadBalancingRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LoadBalancingRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LoadBalancingRule
  • reduce(callbackfn: function, initialValue: LoadBalancingRule): LoadBalancingRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancingRule, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): LoadBalancingRule
        • Parameters

          • previousValue: LoadBalancingRule
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns LoadBalancingRule

    Returns LoadBalancingRule

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancingRule, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): LoadBalancingRule
        • Parameters

          • previousValue: LoadBalancingRule
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns LoadBalancingRule

    • initialValue: LoadBalancingRule

    Returns LoadBalancingRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LoadBalancingRule
  • reduceRight(callbackfn: function, initialValue: LoadBalancingRule): LoadBalancingRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancingRule, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): LoadBalancingRule
        • Parameters

          • previousValue: LoadBalancingRule
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns LoadBalancingRule

    Returns LoadBalancingRule

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancingRule, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): LoadBalancingRule
        • Parameters

          • previousValue: LoadBalancingRule
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns LoadBalancingRule

    • initialValue: LoadBalancingRule

    Returns LoadBalancingRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancingRule, currentIndex: number, array: LoadBalancingRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancingRule
          • currentIndex: number
          • array: LoadBalancingRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LoadBalancingRule[]
  • Reverses the elements in an Array.

    Returns LoadBalancingRule[]

shift

  • shift(): LoadBalancingRule | undefined
  • Removes the first element from an array and returns it.

    Returns LoadBalancingRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LoadBalancingRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LoadBalancingRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LoadBalancingRule, index: number, array: LoadBalancingRule[]): boolean
        • Parameters

          • value: LoadBalancingRule
          • index: number
          • array: LoadBalancingRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LoadBalancingRule[]
  • splice(start: number, deleteCount: number, ...items: LoadBalancingRule[]): LoadBalancingRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LoadBalancingRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LoadBalancingRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns LoadBalancingRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LoadBalancingRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LoadBalancingRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LoadBalancingRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<LoadBalancingRule>

type

type: object

className

className: string = "LoadBalancerLoadBalancingRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadBalancingRule"

name

name: "Composite" = "Composite"

Const LoadBalancerProbeListResult

LoadBalancerProbeListResult: object
interface

Response for ListProbe API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LoadBalancerProbeListResult"

__@iterator

  • __@iterator(): IterableIterator<Probe>
  • Iterator

    Returns IterableIterator<Probe>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Probe>[]): Probe[]
  • concat(...items: (T | ConcatArray<T>)[]): Probe[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Probe>[]

      Additional items to add to the end of array1.

    Returns Probe[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Probe[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Probe]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Probe]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Probe, index: number, array: Probe[]): boolean
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Probe, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Probe

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Probe[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Probe

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Probe, index: number, array: Probe[]): boolean
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Probe, index: number, array: Probe[]): any
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Probe[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Probe | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Probe

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Probe, index: number, obj: Probe[]): boolean
        • Parameters

          • this: void
          • value: Probe
          • index: number
          • obj: Probe[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Probe, index: number, obj: Probe[]): boolean
        • Parameters

          • value: Probe
          • index: number
          • obj: Probe[]

          Returns boolean

    • Optional thisArg: any

    Returns Probe | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Probe, index: number, obj: Probe[]): boolean
        • Parameters

          • value: Probe
          • index: number
          • obj: Probe[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Probe, index: number, array: Probe[]): void
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Probe, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Probe

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Probe, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Probe

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Probe, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Probe

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Probe, index: number, array: Probe[]): U
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Probe | undefined
  • Removes the last element from an array and returns it.

    Returns Probe | undefined

push

  • push(...items: Probe[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Probe[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Probe
  • reduce(callbackfn: function, initialValue: Probe): Probe
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Probe, currentValue: Probe, currentIndex: number, array: Probe[]): Probe
        • Parameters

          • previousValue: Probe
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns Probe

    Returns Probe

  • Parameters

    • callbackfn: function
        • (previousValue: Probe, currentValue: Probe, currentIndex: number, array: Probe[]): Probe
        • Parameters

          • previousValue: Probe
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns Probe

    • initialValue: Probe

    Returns Probe

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Probe, currentIndex: number, array: Probe[]): U
        • Parameters

          • previousValue: U
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Probe
  • reduceRight(callbackfn: function, initialValue: Probe): Probe
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Probe, currentValue: Probe, currentIndex: number, array: Probe[]): Probe
        • Parameters

          • previousValue: Probe
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns Probe

    Returns Probe

  • Parameters

    • callbackfn: function
        • (previousValue: Probe, currentValue: Probe, currentIndex: number, array: Probe[]): Probe
        • Parameters

          • previousValue: Probe
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns Probe

    • initialValue: Probe

    Returns Probe

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Probe, currentIndex: number, array: Probe[]): U
        • Parameters

          • previousValue: U
          • currentValue: Probe
          • currentIndex: number
          • array: Probe[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Probe[]
  • Reverses the elements in an Array.

    Returns Probe[]

shift

  • shift(): Probe | undefined
  • Removes the first element from an array and returns it.

    Returns Probe | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Probe[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Probe[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Probe, index: number, array: Probe[]): boolean
        • Parameters

          • value: Probe
          • index: number
          • array: Probe[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Probe[]
  • splice(start: number, deleteCount: number, ...items: Probe[]): Probe[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Probe[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Probe[]

      Elements to insert into the array in place of the deleted elements.

    Returns Probe[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Probe[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Probe[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Probe>
  • Returns an iterable of values in the array

    Returns IterableIterator<Probe>

type

type: object

className

className: string = "LoadBalancerProbeListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Probe"

name

name: "Composite" = "Composite"

Const LoadBalancerSku

LoadBalancerSku: object

SKU of a load balancer

Optional name

Name of a load balancer SKU. Possible values include: 'Basic', 'Standard'

serializedName

serializedName: string = "LoadBalancerSku"

type

type: object

className

className: string = "LoadBalancerSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const LoadBalancingRule

LoadBalancingRule: object

A load balancing rule for a load balancer.

Optional backendAddressPool

backendAddressPool: SubResource

A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.

Optional backendPort

backendPort: undefined | number

The port used for internal connections on the endpoint. Acceptable values are between 0 and

  1. Note that value 0 enables "Any Port"

Optional disableOutboundSnat

disableOutboundSnat: undefined | false | true

Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.

Optional enableFloatingIP

enableFloatingIP: undefined | false | true

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional frontendIPConfiguration

frontendIPConfiguration: SubResource

A reference to frontend IP addresses.

frontendPort

frontendPort: number

The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"

Optional id

id: undefined | string

Resource ID.

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Optional loadDistribution

loadDistribution: LoadDistribution

The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional probe

The reference of the load balancer probe used by the load balancing rule.

protocol

Possible values include: 'Udp', 'Tcp', 'All'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "LoadBalancingRule"

type

type: object

className

className: string = "LoadBalancingRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendAddressPool

backendAddressPool: object

serializedName

serializedName: string = "properties.backendAddressPool"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

backendPort

backendPort: object

serializedName

serializedName: string = "properties.backendPort"

type

type: object

name

name: "Number" = "Number"

disableOutboundSnat

disableOutboundSnat: object

serializedName

serializedName: string = "properties.disableOutboundSnat"

type

type: object

name

name: "Boolean" = "Boolean"

enableFloatingIP

enableFloatingIP: object

serializedName

serializedName: string = "properties.enableFloatingIP"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfiguration

frontendIPConfiguration: object

serializedName

serializedName: string = "properties.frontendIPConfiguration"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

frontendPort

frontendPort: object

required

required: true = true

serializedName

serializedName: string = "properties.frontendPort"

type

type: object

name

name: "Number" = "Number"

idleTimeoutInMinutes

idleTimeoutInMinutes: object

serializedName

serializedName: string = "properties.idleTimeoutInMinutes"

type

type: object

name

name: "Number" = "Number"

loadDistribution

loadDistribution: object

serializedName

serializedName: string = "properties.loadDistribution"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

probe

probe: object

serializedName

serializedName: string = "properties.probe"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const LocalNetworkGateway

LocalNetworkGateway: object

A common class for general resource information

Optional bgpSettings

bgpSettings: BgpSettings

Local network gateway's BGP speaker settings.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional gatewayIpAddress

gatewayIpAddress: undefined | string

IP address of local network gateway.

Optional id

id: undefined | string

Resource ID.

Optional localNetworkAddressSpace

localNetworkAddressSpace: AddressSpace

Local network site address space.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the LocalNetworkGateway resource.

serializedName

serializedName: string = "LocalNetworkGateway"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "LocalNetworkGateway"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bgpSettings

bgpSettings: object

serializedName

serializedName: string = "properties.bgpSettings"

type

type: object

className

className: string = "BgpSettings"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

gatewayIpAddress

gatewayIpAddress: object

serializedName

serializedName: string = "properties.gatewayIpAddress"

type

type: object

name

name: "String" = "String"

localNetworkAddressSpace

localNetworkAddressSpace: object

serializedName

serializedName: string = "properties.localNetworkAddressSpace"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

Const LocalNetworkGatewayListResult

LocalNetworkGatewayListResult: object
interface

Response for ListLocalNetworkGateways API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LocalNetworkGatewayListResult"

__@iterator

  • __@iterator(): IterableIterator<LocalNetworkGateway>
  • Iterator

    Returns IterableIterator<LocalNetworkGateway>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LocalNetworkGateway>[]): LocalNetworkGateway[]
  • concat(...items: (T | ConcatArray<T>)[]): LocalNetworkGateway[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LocalNetworkGateway>[]

      Additional items to add to the end of array1.

    Returns LocalNetworkGateway[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LocalNetworkGateway[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LocalNetworkGateway]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LocalNetworkGateway]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): boolean
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LocalNetworkGateway, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LocalNetworkGateway

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LocalNetworkGateway[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LocalNetworkGateway

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): boolean
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): any
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LocalNetworkGateway[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LocalNetworkGateway | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LocalNetworkGateway

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LocalNetworkGateway, index: number, obj: LocalNetworkGateway[]): boolean
        • Parameters

          • this: void
          • value: LocalNetworkGateway
          • index: number
          • obj: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LocalNetworkGateway, index: number, obj: LocalNetworkGateway[]): boolean
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • obj: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

    Returns LocalNetworkGateway | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LocalNetworkGateway, index: number, obj: LocalNetworkGateway[]): boolean
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • obj: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): void
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LocalNetworkGateway, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LocalNetworkGateway

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LocalNetworkGateway, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LocalNetworkGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LocalNetworkGateway, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LocalNetworkGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): U
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LocalNetworkGateway | undefined
  • Removes the last element from an array and returns it.

    Returns LocalNetworkGateway | undefined

push

  • push(...items: LocalNetworkGateway[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LocalNetworkGateway[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LocalNetworkGateway
  • reduce(callbackfn: function, initialValue: LocalNetworkGateway): LocalNetworkGateway
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LocalNetworkGateway, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): LocalNetworkGateway
        • Parameters

          • previousValue: LocalNetworkGateway
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns LocalNetworkGateway

    Returns LocalNetworkGateway

  • Parameters

    • callbackfn: function
        • (previousValue: LocalNetworkGateway, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): LocalNetworkGateway
        • Parameters

          • previousValue: LocalNetworkGateway
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns LocalNetworkGateway

    • initialValue: LocalNetworkGateway

    Returns LocalNetworkGateway

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LocalNetworkGateway
  • reduceRight(callbackfn: function, initialValue: LocalNetworkGateway): LocalNetworkGateway
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LocalNetworkGateway, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): LocalNetworkGateway
        • Parameters

          • previousValue: LocalNetworkGateway
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns LocalNetworkGateway

    Returns LocalNetworkGateway

  • Parameters

    • callbackfn: function
        • (previousValue: LocalNetworkGateway, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): LocalNetworkGateway
        • Parameters

          • previousValue: LocalNetworkGateway
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns LocalNetworkGateway

    • initialValue: LocalNetworkGateway

    Returns LocalNetworkGateway

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LocalNetworkGateway, currentIndex: number, array: LocalNetworkGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: LocalNetworkGateway
          • currentIndex: number
          • array: LocalNetworkGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LocalNetworkGateway[]
  • Reverses the elements in an Array.

    Returns LocalNetworkGateway[]

shift

  • shift(): LocalNetworkGateway | undefined
  • Removes the first element from an array and returns it.

    Returns LocalNetworkGateway | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LocalNetworkGateway[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LocalNetworkGateway[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LocalNetworkGateway, index: number, array: LocalNetworkGateway[]): boolean
        • Parameters

          • value: LocalNetworkGateway
          • index: number
          • array: LocalNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LocalNetworkGateway[]
  • splice(start: number, deleteCount: number, ...items: LocalNetworkGateway[]): LocalNetworkGateway[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LocalNetworkGateway[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LocalNetworkGateway[]

      Elements to insert into the array in place of the deleted elements.

    Returns LocalNetworkGateway[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LocalNetworkGateway[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LocalNetworkGateway[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LocalNetworkGateway>
  • Returns an iterable of values in the array

    Returns IterableIterator<LocalNetworkGateway>

type

type: object

className

className: string = "LocalNetworkGatewayListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LocalNetworkGateway"

name

name: "Composite" = "Composite"

Const LogSpecification

LogSpecification: object

Description of logging specification.

Optional blobDuration

blobDuration: undefined | string

Duration of the blob.

Optional displayName

displayName: undefined | string

The display name of the specification.

Optional name

name: undefined | string

The name of the specification.

serializedName

serializedName: string = "LogSpecification"

type

type: object

className

className: string = "LogSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const MetricSpecification

MetricSpecification: object

Description of metrics specification.

Optional aggregationType

aggregationType: undefined | string

The aggregation type.

Optional availabilities

availabilities: Availability[]

List of availability.

Optional dimensions

dimensions: Dimension[]

List of dimensions.

Optional displayDescription

displayDescription: undefined | string

The description of the metric.

Optional displayName

displayName: undefined | string

The display name of the metric.

Optional enableRegionalMdmAccount

enableRegionalMdmAccount: undefined | false | true

Whether regional MDM account enabled.

Optional fillGapWithZero

fillGapWithZero: undefined | false | true

Whether gaps would be filled with zeros.

Optional isInternal

isInternal: undefined | false | true

Whether the metric is internal.

Optional metricFilterPattern

metricFilterPattern: undefined | string

Pattern for the filter of the metric.

Optional name

name: undefined | string

The name of the metric.

Optional resourceIdDimensionNameOverride

resourceIdDimensionNameOverride: undefined | string

The resource Id dimension name override.

serializedName

serializedName: string = "MetricSpecification"

Optional sourceMdmAccount

sourceMdmAccount: undefined | string

The source MDM account.

Optional sourceMdmNamespace

sourceMdmNamespace: undefined | string

The source MDM namespace.

Optional unit

unit: undefined | string

Units the metric to be displayed in.

type

type: object

className

className: string = "MetricSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aggregationType

aggregationType: object

serializedName

serializedName: string = "aggregationType"

type

type: object

name

name: "String" = "String"

availabilities

availabilities: object

serializedName

serializedName: string = "availabilities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Availability"

name

name: "Composite" = "Composite"

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Dimension"

name

name: "Composite" = "Composite"

displayDescription

displayDescription: object

serializedName

serializedName: string = "displayDescription"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

enableRegionalMdmAccount

enableRegionalMdmAccount: object

serializedName

serializedName: string = "enableRegionalMdmAccount"

type

type: object

name

name: "Boolean" = "Boolean"

fillGapWithZero

fillGapWithZero: object

serializedName

serializedName: string = "fillGapWithZero"

type

type: object

name

name: "Boolean" = "Boolean"

isInternal

isInternal: object

serializedName

serializedName: string = "isInternal"

type

type: object

name

name: "Boolean" = "Boolean"

metricFilterPattern

metricFilterPattern: object

serializedName

serializedName: string = "metricFilterPattern"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

resourceIdDimensionNameOverride

resourceIdDimensionNameOverride: object

serializedName

serializedName: string = "resourceIdDimensionNameOverride"

type

type: object

name

name: "String" = "String"

sourceMdmAccount

sourceMdmAccount: object

serializedName

serializedName: string = "sourceMdmAccount"

type

type: object

name

name: "String" = "String"

sourceMdmNamespace

sourceMdmNamespace: object

serializedName

serializedName: string = "sourceMdmNamespace"

type

type: object

name

name: "String" = "String"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const NetworkInterface

NetworkInterface: object

A network interface in a resource group.

Optional dnsSettings

The DNS settings in network interface.

Optional enableAcceleratedNetworking

enableAcceleratedNetworking: undefined | false | true

If the network interface is accelerated networking enabled.

Optional enableIPForwarding

enableIPForwarding: undefined | false | true

Indicates whether IP forwarding is enabled on this network interface.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurations

ipConfigurations: NetworkInterfaceIPConfiguration[]

A list of IPConfigurations of the network interface.

Optional location

location: undefined | string

Resource location.

Optional macAddress

macAddress: undefined | string

The MAC address of the network interface.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkSecurityGroup

networkSecurityGroup: NetworkSecurityGroup

The reference of the NetworkSecurityGroup resource.

Optional primary

primary: undefined | false | true

Gets whether this is a primary network interface on a virtual machine.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the network interface resource.

serializedName

serializedName: string = "NetworkInterface"

Optional tags

tags: undefined | object

Resource tags.

Optional virtualMachine

virtualMachine: SubResource

The reference of a virtual machine.

type

type: object

className

className: string = "NetworkInterface"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dnsSettings

dnsSettings: object

serializedName

serializedName: string = "properties.dnsSettings"

type

type: object

className

className: string = "NetworkInterfaceDnsSettings"

name

name: "Composite" = "Composite"

enableAcceleratedNetworking

enableAcceleratedNetworking: object

serializedName

serializedName: string = "properties.enableAcceleratedNetworking"

type

type: object

name

name: "Boolean" = "Boolean"

enableIPForwarding

enableIPForwarding: object

serializedName

serializedName: string = "properties.enableIPForwarding"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipConfigurations

ipConfigurations: object

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

macAddress

macAddress: object

serializedName

serializedName: string = "properties.macAddress"

type

type: object

name

name: "String" = "String"

networkSecurityGroup

networkSecurityGroup: object

serializedName

serializedName: string = "properties.networkSecurityGroup"

type

type: object

className

className: string = "NetworkSecurityGroup"

name

name: "Composite" = "Composite"

primary

primary: object

serializedName

serializedName: string = "properties.primary"

type

type: object

name

name: "Boolean" = "Boolean"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

virtualMachine

virtualMachine: object

serializedName

serializedName: string = "properties.virtualMachine"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const NetworkInterfaceDnsSettings

NetworkInterfaceDnsSettings: object

DNS settings of a network interface.

Optional appliedDnsServers

appliedDnsServers: string[]

If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.

Optional dnsServers

dnsServers: string[]

List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.

Optional internalDnsNameLabel

internalDnsNameLabel: undefined | string

Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.

Optional internalDomainNameSuffix

internalDomainNameSuffix: undefined | string

Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.

Optional internalFqdn

internalFqdn: undefined | string

Fully qualified DNS name supporting internal communications between VMs in the same virtual network.

serializedName

serializedName: string = "NetworkInterfaceDnsSettings"

type

type: object

className

className: string = "NetworkInterfaceDnsSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

appliedDnsServers

appliedDnsServers: object

serializedName

serializedName: string = "appliedDnsServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

dnsServers

dnsServers: object

serializedName

serializedName: string = "dnsServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

internalDnsNameLabel

internalDnsNameLabel: object

serializedName

serializedName: string = "internalDnsNameLabel"

type

type: object

name

name: "String" = "String"

internalDomainNameSuffix

internalDomainNameSuffix: object

serializedName

serializedName: string = "internalDomainNameSuffix"

type

type: object

name

name: "String" = "String"

internalFqdn

internalFqdn: object

serializedName

serializedName: string = "internalFqdn"

type

type: object

name

name: "String" = "String"

Const NetworkInterfaceIPConfiguration

NetworkInterfaceIPConfiguration: object

IPConfiguration in a network interface.

Optional applicationGatewayBackendAddressPools

applicationGatewayBackendAddressPools: ApplicationGatewayBackendAddressPool[]

The reference of ApplicationGatewayBackendAddressPool resource.

Optional applicationSecurityGroups

applicationSecurityGroups: ApplicationSecurityGroup[]

Application security groups in which the IP configuration is included.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional loadBalancerBackendAddressPools

loadBalancerBackendAddressPools: BackendAddressPool[]

The reference of LoadBalancerBackendAddressPool resource.

Optional loadBalancerInboundNatRules

loadBalancerInboundNatRules: InboundNatRule[]

A list of references of LoadBalancerInboundNatRules.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional primary

primary: undefined | false | true

Gets whether this is a primary customer address on the network interface.

Optional privateIPAddress

privateIPAddress: undefined | string

Private IP address of the IP configuration.

Optional privateIPAddressVersion

privateIPAddressVersion: IPVersion

Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', 'IPv6'

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddress

publicIPAddress: PublicIPAddress

Public IP address bound to the IP configuration.

serializedName

serializedName: string = "NetworkInterfaceIPConfiguration"

Optional subnet

subnet: Subnet

Subnet bound to the IP configuration.

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationGatewayBackendAddressPools

applicationGatewayBackendAddressPools: object

serializedName

serializedName: string = "properties.applicationGatewayBackendAddressPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationGatewayBackendAddressPool"

name

name: "Composite" = "Composite"

applicationSecurityGroups

applicationSecurityGroups: object

serializedName

serializedName: string = "properties.applicationSecurityGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationSecurityGroup"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

loadBalancerBackendAddressPools

loadBalancerBackendAddressPools: object

serializedName

serializedName: string = "properties.loadBalancerBackendAddressPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackendAddressPool"

name

name: "Composite" = "Composite"

loadBalancerInboundNatRules

loadBalancerInboundNatRules: object

serializedName

serializedName: string = "properties.loadBalancerInboundNatRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNatRule"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

primary

primary: object

serializedName

serializedName: string = "properties.primary"

type

type: object

name

name: "Boolean" = "Boolean"

privateIPAddress

privateIPAddress: object

serializedName

serializedName: string = "properties.privateIPAddress"

type

type: object

name

name: "String" = "String"

privateIPAddressVersion

privateIPAddressVersion: object

serializedName

serializedName: string = "properties.privateIPAddressVersion"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const NetworkInterfaceIPConfigurationListResult

NetworkInterfaceIPConfigurationListResult: object
interface

Response for list ip configurations API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkInterfaceIPConfigurationListResult"

__@iterator

  • __@iterator(): IterableIterator<NetworkInterfaceIPConfiguration>
  • Iterator

    Returns IterableIterator<NetworkInterfaceIPConfiguration>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<NetworkInterfaceIPConfiguration>[]): NetworkInterfaceIPConfiguration[]
  • concat(...items: (T | ConcatArray<T>)[]): NetworkInterfaceIPConfiguration[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NetworkInterfaceIPConfiguration>[]

      Additional items to add to the end of array1.

    Returns NetworkInterfaceIPConfiguration[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NetworkInterfaceIPConfiguration[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NetworkInterfaceIPConfiguration]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NetworkInterfaceIPConfiguration]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NetworkInterfaceIPConfiguration, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NetworkInterfaceIPConfiguration

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NetworkInterfaceIPConfiguration[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: NetworkInterfaceIPConfiguration

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): any
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NetworkInterfaceIPConfiguration[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NetworkInterfaceIPConfiguration | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: NetworkInterfaceIPConfiguration

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: NetworkInterfaceIPConfiguration, index: number, obj: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • this: void
          • value: NetworkInterfaceIPConfiguration
          • index: number
          • obj: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: NetworkInterfaceIPConfiguration, index: number, obj: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • obj: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

    Returns NetworkInterfaceIPConfiguration | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: NetworkInterfaceIPConfiguration, index: number, obj: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • obj: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): void
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NetworkInterfaceIPConfiguration, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NetworkInterfaceIPConfiguration

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NetworkInterfaceIPConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NetworkInterfaceIPConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NetworkInterfaceIPConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NetworkInterfaceIPConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): U
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): NetworkInterfaceIPConfiguration | undefined
  • Removes the last element from an array and returns it.

    Returns NetworkInterfaceIPConfiguration | undefined

push

  • push(...items: NetworkInterfaceIPConfiguration[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NetworkInterfaceIPConfiguration[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NetworkInterfaceIPConfiguration
  • reduce(callbackfn: function, initialValue: NetworkInterfaceIPConfiguration): NetworkInterfaceIPConfiguration
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkInterfaceIPConfiguration, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): NetworkInterfaceIPConfiguration
        • Parameters

          • previousValue: NetworkInterfaceIPConfiguration
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns NetworkInterfaceIPConfiguration

    Returns NetworkInterfaceIPConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkInterfaceIPConfiguration, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): NetworkInterfaceIPConfiguration
        • Parameters

          • previousValue: NetworkInterfaceIPConfiguration
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns NetworkInterfaceIPConfiguration

    • initialValue: NetworkInterfaceIPConfiguration

    Returns NetworkInterfaceIPConfiguration

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NetworkInterfaceIPConfiguration
  • reduceRight(callbackfn: function, initialValue: NetworkInterfaceIPConfiguration): NetworkInterfaceIPConfiguration
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkInterfaceIPConfiguration, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): NetworkInterfaceIPConfiguration
        • Parameters

          • previousValue: NetworkInterfaceIPConfiguration
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns NetworkInterfaceIPConfiguration

    Returns NetworkInterfaceIPConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkInterfaceIPConfiguration, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): NetworkInterfaceIPConfiguration
        • Parameters

          • previousValue: NetworkInterfaceIPConfiguration
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns NetworkInterfaceIPConfiguration

    • initialValue: NetworkInterfaceIPConfiguration

    Returns NetworkInterfaceIPConfiguration

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkInterfaceIPConfiguration, currentIndex: number, array: NetworkInterfaceIPConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkInterfaceIPConfiguration
          • currentIndex: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): NetworkInterfaceIPConfiguration[]
  • Reverses the elements in an Array.

    Returns NetworkInterfaceIPConfiguration[]

shift

  • shift(): NetworkInterfaceIPConfiguration | undefined
  • Removes the first element from an array and returns it.

    Returns NetworkInterfaceIPConfiguration | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NetworkInterfaceIPConfiguration[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NetworkInterfaceIPConfiguration[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: NetworkInterfaceIPConfiguration, index: number, array: NetworkInterfaceIPConfiguration[]): boolean
        • Parameters

          • value: NetworkInterfaceIPConfiguration
          • index: number
          • array: NetworkInterfaceIPConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NetworkInterfaceIPConfiguration[]
  • splice(start: number, deleteCount: number, ...items: NetworkInterfaceIPConfiguration[]): NetworkInterfaceIPConfiguration[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NetworkInterfaceIPConfiguration[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NetworkInterfaceIPConfiguration[]

      Elements to insert into the array in place of the deleted elements.

    Returns NetworkInterfaceIPConfiguration[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: NetworkInterfaceIPConfiguration[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NetworkInterfaceIPConfiguration[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<NetworkInterfaceIPConfiguration>
  • Returns an iterable of values in the array

    Returns IterableIterator<NetworkInterfaceIPConfiguration>

type

type: object

className

className: string = "NetworkInterfaceIPConfigurationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterfaceIPConfiguration"

name

name: "Composite" = "Composite"

Const NetworkInterfaceListResult

NetworkInterfaceListResult: object
interface

Response for the ListNetworkInterface API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkInterfaceListResult"

__@iterator

  • __@iterator(): IterableIterator<NetworkInterface>
  • Iterator

    Returns IterableIterator<NetworkInterface>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<NetworkInterface>[]): NetworkInterface[]
  • concat(...items: (T | ConcatArray<T>)[]): NetworkInterface[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NetworkInterface>[]

      Additional items to add to the end of array1.

    Returns NetworkInterface[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NetworkInterface[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NetworkInterface]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NetworkInterface]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): boolean
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NetworkInterface, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NetworkInterface

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NetworkInterface[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: NetworkInterface

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): boolean
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): any
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NetworkInterface[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NetworkInterface | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: NetworkInterface

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: NetworkInterface, index: number, obj: NetworkInterface[]): boolean
        • Parameters

          • this: void
          • value: NetworkInterface
          • index: number
          • obj: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: NetworkInterface, index: number, obj: NetworkInterface[]): boolean
        • Parameters

          • value: NetworkInterface
          • index: number
          • obj: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

    Returns NetworkInterface | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: NetworkInterface, index: number, obj: NetworkInterface[]): boolean
        • Parameters

          • value: NetworkInterface
          • index: number
          • obj: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): void
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NetworkInterface, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NetworkInterface

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NetworkInterface, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NetworkInterface

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NetworkInterface, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NetworkInterface

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): U
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): NetworkInterface | undefined
  • Removes the last element from an array and returns it.

    Returns NetworkInterface | undefined

push

  • push(...items: NetworkInterface[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NetworkInterface[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NetworkInterface
  • reduce(callbackfn: function, initialValue: NetworkInterface): NetworkInterface
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkInterface, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): NetworkInterface
        • Parameters

          • previousValue: NetworkInterface
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns NetworkInterface

    Returns NetworkInterface

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkInterface, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): NetworkInterface
        • Parameters

          • previousValue: NetworkInterface
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns NetworkInterface

    • initialValue: NetworkInterface

    Returns NetworkInterface

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NetworkInterface
  • reduceRight(callbackfn: function, initialValue: NetworkInterface): NetworkInterface
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkInterface, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): NetworkInterface
        • Parameters

          • previousValue: NetworkInterface
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns NetworkInterface

    Returns NetworkInterface

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkInterface, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): NetworkInterface
        • Parameters

          • previousValue: NetworkInterface
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns NetworkInterface

    • initialValue: NetworkInterface

    Returns NetworkInterface

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkInterface, currentIndex: number, array: NetworkInterface[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkInterface
          • currentIndex: number
          • array: NetworkInterface[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): NetworkInterface[]
  • Reverses the elements in an Array.

    Returns NetworkInterface[]

shift

  • shift(): NetworkInterface | undefined
  • Removes the first element from an array and returns it.

    Returns NetworkInterface | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NetworkInterface[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NetworkInterface[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: NetworkInterface, index: number, array: NetworkInterface[]): boolean
        • Parameters

          • value: NetworkInterface
          • index: number
          • array: NetworkInterface[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NetworkInterface[]
  • splice(start: number, deleteCount: number, ...items: NetworkInterface[]): NetworkInterface[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NetworkInterface[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NetworkInterface[]

      Elements to insert into the array in place of the deleted elements.

    Returns NetworkInterface[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: NetworkInterface[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NetworkInterface[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<NetworkInterface>
  • Returns an iterable of values in the array

    Returns IterableIterator<NetworkInterface>

type

type: object

className

className: string = "NetworkInterfaceListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterface"

name

name: "Composite" = "Composite"

Const NetworkInterfaceLoadBalancerListResult

NetworkInterfaceLoadBalancerListResult: object
interface

Response for list ip configurations API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkInterfaceLoadBalancerListResult"

__@iterator

  • __@iterator(): IterableIterator<LoadBalancer>
  • Iterator

    Returns IterableIterator<LoadBalancer>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<LoadBalancer>[]): LoadBalancer[]
  • concat(...items: (T | ConcatArray<T>)[]): LoadBalancer[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LoadBalancer>[]

      Additional items to add to the end of array1.

    Returns LoadBalancer[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LoadBalancer[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LoadBalancer]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LoadBalancer]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LoadBalancer, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LoadBalancer

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LoadBalancer[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: LoadBalancer

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): any
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LoadBalancer[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LoadBalancer | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: LoadBalancer

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • this: void
          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

    Returns LoadBalancer | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: LoadBalancer, index: number, obj: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • obj: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): void
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LoadBalancer, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LoadBalancer

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LoadBalancer, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LoadBalancer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LoadBalancer, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LoadBalancer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): U
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): LoadBalancer | undefined
  • Removes the last element from an array and returns it.

    Returns LoadBalancer | undefined

push

  • push(...items: LoadBalancer[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LoadBalancer[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LoadBalancer
  • reduce(callbackfn: function, initialValue: LoadBalancer): LoadBalancer
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    Returns LoadBalancer

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    • initialValue: LoadBalancer

    Returns LoadBalancer

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LoadBalancer
  • reduceRight(callbackfn: function, initialValue: LoadBalancer): LoadBalancer
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    Returns LoadBalancer

  • Parameters

    • callbackfn: function
        • (previousValue: LoadBalancer, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): LoadBalancer
        • Parameters

          • previousValue: LoadBalancer
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns LoadBalancer

    • initialValue: LoadBalancer

    Returns LoadBalancer

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LoadBalancer, currentIndex: number, array: LoadBalancer[]): U
        • Parameters

          • previousValue: U
          • currentValue: LoadBalancer
          • currentIndex: number
          • array: LoadBalancer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): LoadBalancer[]
  • Reverses the elements in an Array.

    Returns LoadBalancer[]

shift

  • shift(): LoadBalancer | undefined
  • Removes the first element from an array and returns it.

    Returns LoadBalancer | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LoadBalancer[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LoadBalancer[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: LoadBalancer, index: number, array: LoadBalancer[]): boolean
        • Parameters

          • value: LoadBalancer
          • index: number
          • array: LoadBalancer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LoadBalancer[]
  • splice(start: number, deleteCount: number, ...items: LoadBalancer[]): LoadBalancer[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LoadBalancer[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LoadBalancer[]

      Elements to insert into the array in place of the deleted elements.

    Returns LoadBalancer[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: LoadBalancer[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LoadBalancer[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<LoadBalancer>
  • Returns an iterable of values in the array

    Returns IterableIterator<LoadBalancer>

type

type: object

className

className: string = "NetworkInterfaceLoadBalancerListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadBalancer"

name

name: "Composite" = "Composite"

Const NetworkSecurityGroup

NetworkSecurityGroup: object

NetworkSecurityGroup resource.

Optional defaultSecurityRules

defaultSecurityRules: SecurityRule[]

The default security rules of network security group.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkInterfaces

networkInterfaces: NetworkInterface[]

A collection of references to network interfaces. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the network security group resource.

Optional securityRules

securityRules: SecurityRule[]

A collection of security rules of the network security group.

serializedName

serializedName: string = "NetworkSecurityGroup"

Optional subnets

subnets: Subnet[]

A collection of references to subnets. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "NetworkSecurityGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultSecurityRules

defaultSecurityRules: object

serializedName

serializedName: string = "properties.defaultSecurityRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

networkInterfaces

networkInterfaces: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.networkInterfaces"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkInterface"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

securityRules

securityRules: object

serializedName

serializedName: string = "properties.securityRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

subnets

subnets: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const NetworkSecurityGroupListResult

NetworkSecurityGroupListResult: object
interface

Response for ListNetworkSecurityGroups API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "NetworkSecurityGroupListResult"

__@iterator

  • __@iterator(): IterableIterator<NetworkSecurityGroup>
  • Iterator

    Returns IterableIterator<NetworkSecurityGroup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<NetworkSecurityGroup>[]): NetworkSecurityGroup[]
  • concat(...items: (T | ConcatArray<T>)[]): NetworkSecurityGroup[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NetworkSecurityGroup>[]

      Additional items to add to the end of array1.

    Returns NetworkSecurityGroup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NetworkSecurityGroup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NetworkSecurityGroup]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NetworkSecurityGroup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): boolean
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NetworkSecurityGroup, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NetworkSecurityGroup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NetworkSecurityGroup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: NetworkSecurityGroup

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): boolean
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): any
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NetworkSecurityGroup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NetworkSecurityGroup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: NetworkSecurityGroup

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: NetworkSecurityGroup, index: number, obj: NetworkSecurityGroup[]): boolean
        • Parameters

          • this: void
          • value: NetworkSecurityGroup
          • index: number
          • obj: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: NetworkSecurityGroup, index: number, obj: NetworkSecurityGroup[]): boolean
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • obj: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

    Returns NetworkSecurityGroup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: NetworkSecurityGroup, index: number, obj: NetworkSecurityGroup[]): boolean
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • obj: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): void
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NetworkSecurityGroup, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NetworkSecurityGroup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NetworkSecurityGroup, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NetworkSecurityGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NetworkSecurityGroup, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NetworkSecurityGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): U
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): NetworkSecurityGroup | undefined
  • Removes the last element from an array and returns it.

    Returns NetworkSecurityGroup | undefined

push

  • push(...items: NetworkSecurityGroup[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NetworkSecurityGroup[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NetworkSecurityGroup
  • reduce(callbackfn: function, initialValue: NetworkSecurityGroup): NetworkSecurityGroup
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkSecurityGroup, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): NetworkSecurityGroup
        • Parameters

          • previousValue: NetworkSecurityGroup
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns NetworkSecurityGroup

    Returns NetworkSecurityGroup

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkSecurityGroup, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): NetworkSecurityGroup
        • Parameters

          • previousValue: NetworkSecurityGroup
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns NetworkSecurityGroup

    • initialValue: NetworkSecurityGroup

    Returns NetworkSecurityGroup

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NetworkSecurityGroup
  • reduceRight(callbackfn: function, initialValue: NetworkSecurityGroup): NetworkSecurityGroup
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: NetworkSecurityGroup, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): NetworkSecurityGroup
        • Parameters

          • previousValue: NetworkSecurityGroup
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns NetworkSecurityGroup

    Returns NetworkSecurityGroup

  • Parameters

    • callbackfn: function
        • (previousValue: NetworkSecurityGroup, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): NetworkSecurityGroup
        • Parameters

          • previousValue: NetworkSecurityGroup
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns NetworkSecurityGroup

    • initialValue: NetworkSecurityGroup

    Returns NetworkSecurityGroup

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NetworkSecurityGroup, currentIndex: number, array: NetworkSecurityGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: NetworkSecurityGroup
          • currentIndex: number
          • array: NetworkSecurityGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): NetworkSecurityGroup[]
  • Reverses the elements in an Array.

    Returns NetworkSecurityGroup[]

shift

  • shift(): NetworkSecurityGroup | undefined
  • Removes the first element from an array and returns it.

    Returns NetworkSecurityGroup | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NetworkSecurityGroup[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NetworkSecurityGroup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: NetworkSecurityGroup, index: number, array: NetworkSecurityGroup[]): boolean
        • Parameters

          • value: NetworkSecurityGroup
          • index: number
          • array: NetworkSecurityGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NetworkSecurityGroup[]
  • splice(start: number, deleteCount: number, ...items: NetworkSecurityGroup[]): NetworkSecurityGroup[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NetworkSecurityGroup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NetworkSecurityGroup[]

      Elements to insert into the array in place of the deleted elements.

    Returns NetworkSecurityGroup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: NetworkSecurityGroup[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NetworkSecurityGroup[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<NetworkSecurityGroup>
  • Returns an iterable of values in the array

    Returns IterableIterator<NetworkSecurityGroup>

type

type: object

className

className: string = "NetworkSecurityGroupListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkSecurityGroup"

name

name: "Composite" = "Composite"

Const Operation

Operation: object

Network REST API operation definition.

Optional display

Display metadata associated with the operation.

Optional name

name: undefined | string

Operation name: {provider}/{resource}/{operation}

Optional origin

origin: undefined | string

Origin of the operation.

serializedName

serializedName: string = "Operation"

Optional serviceSpecification

Specification of the service.

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

origin

origin: object

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

serviceSpecification

serviceSpecification: object

serializedName

serializedName: string = "properties.serviceSpecification"

type

type: object

className

className: string = "OperationPropertiesFormatServiceSpecification"

name

name: "Composite" = "Composite"

Const OperationDisplay

OperationDisplay: object

Display metadata associated with the operation.

Optional description

description: undefined | string

Description of the operation.

Optional operation

operation: undefined | string

Type of the operation: get, read, delete, etc.

Optional provider

provider: undefined | string

Service provider: Microsoft Network.

Optional resource

resource: undefined | string

Resource on which the operation is performed.

serializedName

serializedName: string = "Operation_display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OperationListResult

OperationListResult: object
interface

Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "OperationListResult"

__@iterator

  • __@iterator(): IterableIterator<Operation>
  • Iterator

    Returns IterableIterator<Operation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Operation>[]): Operation[]
  • concat(...items: (T | ConcatArray<T>)[]): Operation[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Operation>[]

      Additional items to add to the end of array1.

    Returns Operation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Operation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Operation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Operation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Operation, index: number, array: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Operation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Operation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Operation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Operation

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): any
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Operation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Operation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Operation

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Operation, index: number, obj: Operation[]): boolean
        • Parameters

          • this: void
          • value: Operation
          • index: number
          • obj: Operation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Operation, index: number, obj: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • obj: Operation[]

          Returns boolean

    • Optional thisArg: any

    Returns Operation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Operation, index: number, obj: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • obj: Operation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): void
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Operation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Operation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Operation, index: number, array: Operation[]): U
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Operation | undefined
  • Removes the last element from an array and returns it.

    Returns Operation | undefined

push

  • push(...items: Operation[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Operation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Operation
  • reduce(callbackfn: function, initialValue: Operation): Operation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    Returns Operation

  • Parameters

    • callbackfn: function
        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    • initialValue: Operation

    Returns Operation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          • previousValue: U
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Operation
  • reduceRight(callbackfn: function, initialValue: Operation): Operation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    Returns Operation

  • Parameters

    • callbackfn: function
        • (previousValue: Operation, currentValue: Operation, currentIndex: number, array: Operation[]): Operation
        • Parameters

          • previousValue: Operation
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns Operation

    • initialValue: Operation

    Returns Operation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          • previousValue: U
          • currentValue: Operation
          • currentIndex: number
          • array: Operation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Operation[]
  • Reverses the elements in an Array.

    Returns Operation[]

shift

  • shift(): Operation | undefined
  • Removes the first element from an array and returns it.

    Returns Operation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Operation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Operation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Operation, index: number, array: Operation[]): boolean
        • Parameters

          • value: Operation
          • index: number
          • array: Operation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Operation[]
  • splice(start: number, deleteCount: number, ...items: Operation[]): Operation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Operation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Operation[]

      Elements to insert into the array in place of the deleted elements.

    Returns Operation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Operation[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Operation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Operation>
  • Returns an iterable of values in the array

    Returns IterableIterator<Operation>

type

type: object

className

className: string = "OperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

Const OperationPropertiesFormatServiceSpecification

OperationPropertiesFormatServiceSpecification: object

Specification of the service.

Optional logSpecifications

logSpecifications: LogSpecification[]

Operation log specification.

Optional metricSpecifications

metricSpecifications: MetricSpecification[]

Operation service specification.

serializedName

serializedName: string = "OperationPropertiesFormat_serviceSpecification"

type

type: object

className

className: string = "OperationPropertiesFormatServiceSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

logSpecifications

logSpecifications: object

serializedName

serializedName: string = "logSpecifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LogSpecification"

name

name: "Composite" = "Composite"

metricSpecifications

metricSpecifications: object

serializedName

serializedName: string = "metricSpecifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricSpecification"

name

name: "Composite" = "Composite"

Const OutboundNatRule

OutboundNatRule: object

Outbound NAT pool of the load balancer.

Optional allocatedOutboundPorts

allocatedOutboundPorts: undefined | number

The number of outbound ports to be used for NAT.

backendAddressPool

backendAddressPool: SubResource

A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional frontendIPConfigurations

frontendIPConfigurations: SubResource[]

The Frontend IP addresses of the load balancer.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "OutboundNatRule"

type

type: object

className

className: string = "OutboundNatRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allocatedOutboundPorts

allocatedOutboundPorts: object

serializedName

serializedName: string = "properties.allocatedOutboundPorts"

type

type: object

name

name: "Number" = "Number"

backendAddressPool

backendAddressPool: object

required

required: true = true

serializedName

serializedName: string = "properties.backendAddressPool"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

frontendIPConfigurations

frontendIPConfigurations: object

serializedName

serializedName: string = "properties.frontendIPConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const Probe

Probe: object

A load balancer probe.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional intervalInSeconds

intervalInSeconds: undefined | number

The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.

Optional loadBalancingRules

loadBalancingRules: SubResource[]

The load balancer rules that use this probe. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional numberOfProbes

numberOfProbes: undefined | number

The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.

port

port: number

The port for communicating the probe. Possible values range from 1 to 65535, inclusive.

protocol

protocol: ProbeProtocol

The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful. Possible values include: 'Http', 'Tcp'

Optional provisioningState

provisioningState: undefined | string

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional requestPath

requestPath: undefined | string

The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.

serializedName

serializedName: string = "Probe"

type

type: object

className

className: string = "Probe"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

intervalInSeconds

intervalInSeconds: object

serializedName

serializedName: string = "properties.intervalInSeconds"

type

type: object

name

name: "Number" = "Number"

loadBalancingRules

loadBalancingRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.loadBalancingRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

numberOfProbes

numberOfProbes: object

serializedName

serializedName: string = "properties.numberOfProbes"

type

type: object

name

name: "Number" = "Number"

port

port: object

required

required: true = true

serializedName

serializedName: string = "properties.port"

type

type: object

name

name: "Number" = "Number"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

requestPath

requestPath: object

serializedName

serializedName: string = "properties.requestPath"

type

type: object

name

name: "String" = "String"

Const PublicIPAddress

PublicIPAddress: object

Public IP address resource.

Optional dnsSettings

The FQDN of the DNS record associated with the public IP address.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

The idle timeout of the public IP address.

Optional ipAddress

ipAddress: undefined | string

The IP address associated with the public IP address resource.

Optional ipConfiguration

ipConfiguration: IPConfiguration

The IP configuration associated with the public IP address. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional publicIPAddressVersion

publicIPAddressVersion: IPVersion

The public IP address version. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', 'IPv6'

Optional publicIPAllocationMethod

publicIPAllocationMethod: IPAllocationMethod

The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic'

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the public IP resource.

serializedName

serializedName: string = "PublicIPAddress"

Optional sku

The public IP address SKU.

Optional tags

tags: undefined | object

Resource tags.

Optional zones

zones: string[]

A list of availability zones denoting the IP allocated for the resource needs to come from.

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dnsSettings

dnsSettings: object

serializedName

serializedName: string = "properties.dnsSettings"

type

type: object

className

className: string = "PublicIPAddressDnsSettings"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

idleTimeoutInMinutes

idleTimeoutInMinutes: object

serializedName

serializedName: string = "properties.idleTimeoutInMinutes"

type

type: object

name

name: "Number" = "Number"

ipAddress

ipAddress: object

serializedName

serializedName: string = "properties.ipAddress"

type

type: object

name

name: "String" = "String"

ipConfiguration

ipConfiguration: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ipConfiguration"

type

type: object

className

className: string = "IPConfiguration"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddressVersion

publicIPAddressVersion: object

serializedName

serializedName: string = "properties.publicIPAddressVersion"

type

type: object

name

name: "String" = "String"

publicIPAllocationMethod

publicIPAllocationMethod: object

serializedName

serializedName: string = "properties.publicIPAllocationMethod"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "PublicIPAddressSku"

name

name: "Composite" = "Composite"

zones

zones: object

serializedName

serializedName: string = "zones"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const PublicIPAddressDnsSettings

PublicIPAddressDnsSettings: object

Contains FQDN of the DNS record associated with the public IP address

Optional domainNameLabel

domainNameLabel: undefined | string

Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

Optional fqdn

fqdn: undefined | string

Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.

Optional reverseFqdn

reverseFqdn: undefined | string

Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

serializedName

serializedName: string = "PublicIPAddressDnsSettings"

type

type: object

className

className: string = "PublicIPAddressDnsSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

domainNameLabel

domainNameLabel: object

serializedName

serializedName: string = "domainNameLabel"

type

type: object

name

name: "String" = "String"

fqdn

fqdn: object

serializedName

serializedName: string = "fqdn"

type

type: object

name

name: "String" = "String"

reverseFqdn

reverseFqdn: object

serializedName

serializedName: string = "reverseFqdn"

type

type: object

name

name: "String" = "String"

Const PublicIPAddressListResult

PublicIPAddressListResult: object
interface

Response for ListPublicIpAddresses API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "PublicIPAddressListResult"

__@iterator

  • __@iterator(): IterableIterator<PublicIPAddress>
  • Iterator

    Returns IterableIterator<PublicIPAddress>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<PublicIPAddress>[]): PublicIPAddress[]
  • concat(...items: (T | ConcatArray<T>)[]): PublicIPAddress[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PublicIPAddress>[]

      Additional items to add to the end of array1.

    Returns PublicIPAddress[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PublicIPAddress[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, PublicIPAddress]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PublicIPAddress]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): boolean
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PublicIPAddress, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PublicIPAddress

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PublicIPAddress[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: PublicIPAddress

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): boolean
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): any
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PublicIPAddress[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PublicIPAddress | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: PublicIPAddress

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: PublicIPAddress, index: number, obj: PublicIPAddress[]): boolean
        • Parameters

          • this: void
          • value: PublicIPAddress
          • index: number
          • obj: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: PublicIPAddress, index: number, obj: PublicIPAddress[]): boolean
        • Parameters

          • value: PublicIPAddress
          • index: number
          • obj: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

    Returns PublicIPAddress | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: PublicIPAddress, index: number, obj: PublicIPAddress[]): boolean
        • Parameters

          • value: PublicIPAddress
          • index: number
          • obj: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): void
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PublicIPAddress, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PublicIPAddress

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PublicIPAddress, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PublicIPAddress

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PublicIPAddress, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PublicIPAddress

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): U
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): PublicIPAddress | undefined
  • Removes the last element from an array and returns it.

    Returns PublicIPAddress | undefined

push

  • push(...items: PublicIPAddress[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: PublicIPAddress[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): PublicIPAddress
  • reduce(callbackfn: function, initialValue: PublicIPAddress): PublicIPAddress
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: PublicIPAddress, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): PublicIPAddress
        • Parameters

          • previousValue: PublicIPAddress
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns PublicIPAddress

    Returns PublicIPAddress

  • Parameters

    • callbackfn: function
        • (previousValue: PublicIPAddress, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): PublicIPAddress
        • Parameters

          • previousValue: PublicIPAddress
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns PublicIPAddress

    • initialValue: PublicIPAddress

    Returns PublicIPAddress

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): U
        • Parameters

          • previousValue: U
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): PublicIPAddress
  • reduceRight(callbackfn: function, initialValue: PublicIPAddress): PublicIPAddress
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: PublicIPAddress, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): PublicIPAddress
        • Parameters

          • previousValue: PublicIPAddress
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns PublicIPAddress

    Returns PublicIPAddress

  • Parameters

    • callbackfn: function
        • (previousValue: PublicIPAddress, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): PublicIPAddress
        • Parameters

          • previousValue: PublicIPAddress
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns PublicIPAddress

    • initialValue: PublicIPAddress

    Returns PublicIPAddress

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PublicIPAddress, currentIndex: number, array: PublicIPAddress[]): U
        • Parameters

          • previousValue: U
          • currentValue: PublicIPAddress
          • currentIndex: number
          • array: PublicIPAddress[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): PublicIPAddress[]
  • Reverses the elements in an Array.

    Returns PublicIPAddress[]

shift

  • shift(): PublicIPAddress | undefined
  • Removes the first element from an array and returns it.

    Returns PublicIPAddress | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PublicIPAddress[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PublicIPAddress[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: PublicIPAddress, index: number, array: PublicIPAddress[]): boolean
        • Parameters

          • value: PublicIPAddress
          • index: number
          • array: PublicIPAddress[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): PublicIPAddress[]
  • splice(start: number, deleteCount: number, ...items: PublicIPAddress[]): PublicIPAddress[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PublicIPAddress[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PublicIPAddress[]

      Elements to insert into the array in place of the deleted elements.

    Returns PublicIPAddress[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: PublicIPAddress[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PublicIPAddress[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<PublicIPAddress>
  • Returns an iterable of values in the array

    Returns IterableIterator<PublicIPAddress>

type

type: object

className

className: string = "PublicIPAddressListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PublicIPAddress"

name

name: "Composite" = "Composite"

Const PublicIPAddressSku

PublicIPAddressSku: object

SKU of a public IP address

Optional name

Name of a public IP address SKU. Possible values include: 'Basic', 'Standard'

serializedName

serializedName: string = "PublicIPAddressSku"

type

type: object

className

className: string = "PublicIPAddressSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const Resource

Resource: object

Common resource representation.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceNavigationLink

ResourceNavigationLink: object

ResourceNavigationLink resource.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID.

Optional link

link: undefined | string

Link to the external resource

Optional linkedResourceType

linkedResourceType: undefined | string

Resource type of the linked resource.

Optional name

name: undefined | string

Name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

Provisioning state of the ResourceNavigationLink resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceNavigationLink"

type

type: object

className

className: string = "ResourceNavigationLink"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

link

link: object

serializedName

serializedName: string = "properties.link"

type

type: object

name

name: "String" = "String"

linkedResourceType

linkedResourceType: object

serializedName

serializedName: string = "properties.linkedResourceType"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const Route

Route: object

Route resource

Optional addressPrefix

addressPrefix: undefined | string

The destination CIDR to which the route applies.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional nextHopIpAddress

nextHopIpAddress: undefined | string

The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

nextHopType

nextHopType: RouteNextHopType

The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. Possible values include: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', 'None'

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "Route"

type

type: object

className

className: string = "Route"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefix

addressPrefix: object

serializedName

serializedName: string = "properties.addressPrefix"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

nextHopIpAddress

nextHopIpAddress: object

serializedName

serializedName: string = "properties.nextHopIpAddress"

type

type: object

name

name: "String" = "String"

nextHopType

nextHopType: object

required

required: true = true

serializedName

serializedName: string = "properties.nextHopType"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

Const RouteListResult

RouteListResult: object
interface

Response for the ListRoute API service call

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "RouteListResult"

__@iterator

  • __@iterator(): IterableIterator<Route>
  • Iterator

    Returns IterableIterator<Route>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Route>[]): Route[]
  • concat(...items: (T | ConcatArray<T>)[]): Route[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Route>[]

      Additional items to add to the end of array1.

    Returns Route[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Route[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Route]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Route]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Route, index: number, array: Route[]): boolean
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Route, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Route

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Route[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Route

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Route, index: number, array: Route[]): boolean
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Route, index: number, array: Route[]): any
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Route[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Route | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Route

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Route, index: number, obj: Route[]): boolean
        • Parameters

          • this: void
          • value: Route
          • index: number
          • obj: Route[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Route, index: number, obj: Route[]): boolean
        • Parameters

          • value: Route
          • index: number
          • obj: Route[]

          Returns boolean

    • Optional thisArg: any

    Returns Route | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Route, index: number, obj: Route[]): boolean
        • Parameters

          • value: Route
          • index: number
          • obj: Route[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Route, index: number, array: Route[]): void
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Route, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Route

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Route, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Route

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Route, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Route

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Route, index: number, array: Route[]): U
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Route | undefined
  • Removes the last element from an array and returns it.

    Returns Route | undefined

push

  • push(...items: Route[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Route[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Route
  • reduce(callbackfn: function, initialValue: Route): Route
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Route, currentValue: Route, currentIndex: number, array: Route[]): Route
        • Parameters

          • previousValue: Route
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns Route

    Returns Route

  • Parameters

    • callbackfn: function
        • (previousValue: Route, currentValue: Route, currentIndex: number, array: Route[]): Route
        • Parameters

          • previousValue: Route
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns Route

    • initialValue: Route

    Returns Route

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Route, currentIndex: number, array: Route[]): U
        • Parameters

          • previousValue: U
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Route
  • reduceRight(callbackfn: function, initialValue: Route): Route
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Route, currentValue: Route, currentIndex: number, array: Route[]): Route
        • Parameters

          • previousValue: Route
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns Route

    Returns Route

  • Parameters

    • callbackfn: function
        • (previousValue: Route, currentValue: Route, currentIndex: number, array: Route[]): Route
        • Parameters

          • previousValue: Route
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns Route

    • initialValue: Route

    Returns Route

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Route, currentIndex: number, array: Route[]): U
        • Parameters

          • previousValue: U
          • currentValue: Route
          • currentIndex: number
          • array: Route[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Route[]
  • Reverses the elements in an Array.

    Returns Route[]

shift

  • shift(): Route | undefined
  • Removes the first element from an array and returns it.

    Returns Route | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Route[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Route[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Route, index: number, array: Route[]): boolean
        • Parameters

          • value: Route
          • index: number
          • array: Route[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Route[]
  • splice(start: number, deleteCount: number, ...items: Route[]): Route[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Route[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Route[]

      Elements to insert into the array in place of the deleted elements.

    Returns Route[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Route[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Route[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Route>
  • Returns an iterable of values in the array

    Returns IterableIterator<Route>

type

type: object

className

className: string = "RouteListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Route"

name

name: "Composite" = "Composite"

Const RouteTable

RouteTable: object

Route table resource.

Optional disableBgpRoutePropagation

disableBgpRoutePropagation: undefined | false | true

Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional routes

routes: Route[]

Collection of routes contained within a route table.

serializedName

serializedName: string = "RouteTable"

Optional subnets

subnets: Subnet[]

A collection of references to subnets. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "RouteTable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

disableBgpRoutePropagation

disableBgpRoutePropagation: object

serializedName

serializedName: string = "properties.disableBgpRoutePropagation"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

routes

routes: object

serializedName

serializedName: string = "properties.routes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Route"

name

name: "Composite" = "Composite"

subnets

subnets: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const RouteTableListResult

RouteTableListResult: object
interface

Response for the ListRouteTable API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "RouteTableListResult"

__@iterator

  • __@iterator(): IterableIterator<RouteTable>
  • Iterator

    Returns IterableIterator<RouteTable>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RouteTable>[]): RouteTable[]
  • concat(...items: (T | ConcatArray<T>)[]): RouteTable[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RouteTable>[]

      Additional items to add to the end of array1.

    Returns RouteTable[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RouteTable[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RouteTable]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RouteTable]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RouteTable, index: number, array: RouteTable[]): boolean
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RouteTable, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RouteTable

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RouteTable[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RouteTable

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RouteTable, index: number, array: RouteTable[]): boolean
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RouteTable, index: number, array: RouteTable[]): any
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RouteTable[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RouteTable | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RouteTable

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RouteTable, index: number, obj: RouteTable[]): boolean
        • Parameters

          • this: void
          • value: RouteTable
          • index: number
          • obj: RouteTable[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RouteTable, index: number, obj: RouteTable[]): boolean
        • Parameters

          • value: RouteTable
          • index: number
          • obj: RouteTable[]

          Returns boolean

    • Optional thisArg: any

    Returns RouteTable | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RouteTable, index: number, obj: RouteTable[]): boolean
        • Parameters

          • value: RouteTable
          • index: number
          • obj: RouteTable[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RouteTable, index: number, array: RouteTable[]): void
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RouteTable, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RouteTable

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RouteTable, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RouteTable

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RouteTable, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RouteTable

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RouteTable, index: number, array: RouteTable[]): U
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RouteTable | undefined
  • Removes the last element from an array and returns it.

    Returns RouteTable | undefined

push

  • push(...items: RouteTable[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RouteTable[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RouteTable
  • reduce(callbackfn: function, initialValue: RouteTable): RouteTable
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RouteTable, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): RouteTable
        • Parameters

          • previousValue: RouteTable
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns RouteTable

    Returns RouteTable

  • Parameters

    • callbackfn: function
        • (previousValue: RouteTable, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): RouteTable
        • Parameters

          • previousValue: RouteTable
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns RouteTable

    • initialValue: RouteTable

    Returns RouteTable

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): U
        • Parameters

          • previousValue: U
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RouteTable
  • reduceRight(callbackfn: function, initialValue: RouteTable): RouteTable
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RouteTable, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): RouteTable
        • Parameters

          • previousValue: RouteTable
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns RouteTable

    Returns RouteTable

  • Parameters

    • callbackfn: function
        • (previousValue: RouteTable, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): RouteTable
        • Parameters

          • previousValue: RouteTable
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns RouteTable

    • initialValue: RouteTable

    Returns RouteTable

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RouteTable, currentIndex: number, array: RouteTable[]): U
        • Parameters

          • previousValue: U
          • currentValue: RouteTable
          • currentIndex: number
          • array: RouteTable[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RouteTable[]
  • Reverses the elements in an Array.

    Returns RouteTable[]

shift

  • shift(): RouteTable | undefined
  • Removes the first element from an array and returns it.

    Returns RouteTable | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RouteTable[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RouteTable[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RouteTable, index: number, array: RouteTable[]): boolean
        • Parameters

          • value: RouteTable
          • index: number
          • array: RouteTable[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RouteTable[]
  • splice(start: number, deleteCount: number, ...items: RouteTable[]): RouteTable[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RouteTable[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RouteTable[]

      Elements to insert into the array in place of the deleted elements.

    Returns RouteTable[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RouteTable[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RouteTable[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RouteTable>
  • Returns an iterable of values in the array

    Returns IterableIterator<RouteTable>

type

type: object

className

className: string = "RouteTableListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RouteTable"

name

name: "Composite" = "Composite"

Const SecurityRule

SecurityRule: object

Network security rule.

access

The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. Possible values include: 'Allow', 'Deny'

Optional description

description: undefined | string

A description for this rule. Restricted to 140 chars.

Optional destinationAddressPrefix

destinationAddressPrefix: undefined | string

The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.

Optional destinationAddressPrefixes

destinationAddressPrefixes: string[]

The destination address prefixes. CIDR or destination IP ranges.

Optional destinationApplicationSecurityGroups

destinationApplicationSecurityGroups: ApplicationSecurityGroup[]

The application security group specified as destination.

Optional destinationPortRange

destinationPortRange: undefined | string

The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.

Optional destinationPortRanges

destinationPortRanges: string[]

The destination port ranges.

direction

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'. Possible values include: 'Inbound', 'Outbound'

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional priority

priority: undefined | number

The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.

protocol

Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and ''. Possible values include: 'Tcp', 'Udp', ''

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

serializedName

serializedName: string = "SecurityRule"

Optional sourceAddressPrefix

sourceAddressPrefix: undefined | string

The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.

Optional sourceAddressPrefixes

sourceAddressPrefixes: string[]

The CIDR or source IP ranges.

Optional sourceApplicationSecurityGroups

sourceApplicationSecurityGroups: ApplicationSecurityGroup[]

The application security group specified as source.

Optional sourcePortRange

sourcePortRange: undefined | string

The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.

Optional sourcePortRanges

sourcePortRanges: string[]

The source port ranges.

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

access

access: object

required

required: true = true

serializedName

serializedName: string = "properties.access"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

destinationAddressPrefix

destinationAddressPrefix: object

serializedName

serializedName: string = "properties.destinationAddressPrefix"

type

type: object

name

name: "String" = "String"

destinationAddressPrefixes

destinationAddressPrefixes: object

serializedName

serializedName: string = "properties.destinationAddressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

destinationApplicationSecurityGroups

destinationApplicationSecurityGroups: object

serializedName

serializedName: string = "properties.destinationApplicationSecurityGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationSecurityGroup"

name

name: "Composite" = "Composite"

destinationPortRange

destinationPortRange: object

serializedName

serializedName: string = "properties.destinationPortRange"

type

type: object

name

name: "String" = "String"

destinationPortRanges

destinationPortRanges: object

serializedName

serializedName: string = "properties.destinationPortRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

direction

direction: object

required

required: true = true

serializedName

serializedName: string = "properties.direction"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

priority

priority: object

serializedName

serializedName: string = "properties.priority"

type

type: object

name

name: "Number" = "Number"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

sourceAddressPrefix

sourceAddressPrefix: object

serializedName

serializedName: string = "properties.sourceAddressPrefix"

type

type: object

name

name: "String" = "String"

sourceAddressPrefixes

sourceAddressPrefixes: object

serializedName

serializedName: string = "properties.sourceAddressPrefixes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

sourceApplicationSecurityGroups

sourceApplicationSecurityGroups: object

serializedName

serializedName: string = "properties.sourceApplicationSecurityGroups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationSecurityGroup"

name

name: "Composite" = "Composite"

sourcePortRange

sourcePortRange: object

serializedName

serializedName: string = "properties.sourcePortRange"

type

type: object

name

name: "String" = "String"

sourcePortRanges

sourcePortRanges: object

serializedName

serializedName: string = "properties.sourcePortRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const SecurityRuleListResult

SecurityRuleListResult: object
interface

Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "SecurityRuleListResult"

__@iterator

  • __@iterator(): IterableIterator<SecurityRule>
  • Iterator

    Returns IterableIterator<SecurityRule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SecurityRule>[]): SecurityRule[]
  • concat(...items: (T | ConcatArray<T>)[]): SecurityRule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SecurityRule>[]

      Additional items to add to the end of array1.

    Returns SecurityRule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SecurityRule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SecurityRule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SecurityRule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): boolean
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SecurityRule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SecurityRule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SecurityRule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SecurityRule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): boolean
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): any
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SecurityRule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SecurityRule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SecurityRule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SecurityRule, index: number, obj: SecurityRule[]): boolean
        • Parameters

          • this: void
          • value: SecurityRule
          • index: number
          • obj: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SecurityRule, index: number, obj: SecurityRule[]): boolean
        • Parameters

          • value: SecurityRule
          • index: number
          • obj: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

    Returns SecurityRule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SecurityRule, index: number, obj: SecurityRule[]): boolean
        • Parameters

          • value: SecurityRule
          • index: number
          • obj: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): void
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SecurityRule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SecurityRule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SecurityRule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SecurityRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SecurityRule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SecurityRule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): U
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SecurityRule | undefined
  • Removes the last element from an array and returns it.

    Returns SecurityRule | undefined

push

  • push(...items: SecurityRule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SecurityRule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SecurityRule
  • reduce(callbackfn: function, initialValue: SecurityRule): SecurityRule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SecurityRule, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): SecurityRule
        • Parameters

          • previousValue: SecurityRule
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns SecurityRule

    Returns SecurityRule

  • Parameters

    • callbackfn: function
        • (previousValue: SecurityRule, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): SecurityRule
        • Parameters

          • previousValue: SecurityRule
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns SecurityRule

    • initialValue: SecurityRule

    Returns SecurityRule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SecurityRule
  • reduceRight(callbackfn: function, initialValue: SecurityRule): SecurityRule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SecurityRule, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): SecurityRule
        • Parameters

          • previousValue: SecurityRule
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns SecurityRule

    Returns SecurityRule

  • Parameters

    • callbackfn: function
        • (previousValue: SecurityRule, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): SecurityRule
        • Parameters

          • previousValue: SecurityRule
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns SecurityRule

    • initialValue: SecurityRule

    Returns SecurityRule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SecurityRule, currentIndex: number, array: SecurityRule[]): U
        • Parameters

          • previousValue: U
          • currentValue: SecurityRule
          • currentIndex: number
          • array: SecurityRule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SecurityRule[]
  • Reverses the elements in an Array.

    Returns SecurityRule[]

shift

  • shift(): SecurityRule | undefined
  • Removes the first element from an array and returns it.

    Returns SecurityRule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SecurityRule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SecurityRule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SecurityRule, index: number, array: SecurityRule[]): boolean
        • Parameters

          • value: SecurityRule
          • index: number
          • array: SecurityRule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SecurityRule[]
  • splice(start: number, deleteCount: number, ...items: SecurityRule[]): SecurityRule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SecurityRule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SecurityRule[]

      Elements to insert into the array in place of the deleted elements.

    Returns SecurityRule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SecurityRule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SecurityRule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SecurityRule>
  • Returns an iterable of values in the array

    Returns IterableIterator<SecurityRule>

type

type: object

className

className: string = "SecurityRuleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SecurityRule"

name

name: "Composite" = "Composite"

Const ServiceEndpointPropertiesFormat

ServiceEndpointPropertiesFormat: object

The service endpoint properties.

Optional locations

locations: string[]

A list of locations.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource.

serializedName

serializedName: string = "ServiceEndpointPropertiesFormat"

Optional service

service: undefined | string

The type of the endpoint service.

type

type: object

className

className: string = "ServiceEndpointPropertiesFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

locations

locations: object

serializedName

serializedName: string = "locations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "provisioningState"

type

type: object

name

name: "String" = "String"

service

service: object

serializedName

serializedName: string = "service"

type

type: object

name

name: "String" = "String"

Const SubResource

SubResource: object

Reference to another subresource.

Optional id

id: undefined | string

Resource ID.

serializedName

serializedName: string = "SubResource"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const Subnet

Subnet: object

Subnet in a virtual network resource.

Optional addressPrefix

addressPrefix: undefined | string

The address prefix for the subnet.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurations

ipConfigurations: IPConfiguration[]

Gets an array of references to the network interface IP configurations using subnet. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional networkSecurityGroup

networkSecurityGroup: NetworkSecurityGroup

The reference of the NetworkSecurityGroup resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource.

Optional resourceNavigationLinks

resourceNavigationLinks: ResourceNavigationLink[]

Gets an array of references to the external resources using subnet.

Optional routeTable

routeTable: RouteTable

The reference of the RouteTable resource.

serializedName

serializedName: string = "Subnet"

Optional serviceEndpoints

serviceEndpoints: ServiceEndpointPropertiesFormat[]

An array of service endpoints.

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressPrefix

addressPrefix: object

serializedName

serializedName: string = "properties.addressPrefix"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ipConfigurations

ipConfigurations: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IPConfiguration"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

networkSecurityGroup

networkSecurityGroup: object

serializedName

serializedName: string = "properties.networkSecurityGroup"

type

type: object

className

className: string = "NetworkSecurityGroup"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceNavigationLinks

resourceNavigationLinks: object

serializedName

serializedName: string = "properties.resourceNavigationLinks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceNavigationLink"

name

name: "Composite" = "Composite"

routeTable

routeTable: object

serializedName

serializedName: string = "properties.routeTable"

type

type: object

className

className: string = "RouteTable"

name

name: "Composite" = "Composite"

serviceEndpoints

serviceEndpoints: object

serializedName

serializedName: string = "properties.serviceEndpoints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ServiceEndpointPropertiesFormat"

name

name: "Composite" = "Composite"

Const SubnetListResult

SubnetListResult: object
interface

Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "SubnetListResult"

__@iterator

  • __@iterator(): IterableIterator<Subnet>
  • Iterator

    Returns IterableIterator<Subnet>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Subnet>[]): Subnet[]
  • concat(...items: (T | ConcatArray<T>)[]): Subnet[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Subnet>[]

      Additional items to add to the end of array1.

    Returns Subnet[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Subnet[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Subnet]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Subnet]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Subnet, index: number, array: Subnet[]): boolean
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Subnet, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Subnet

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Subnet[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Subnet

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Subnet, index: number, array: Subnet[]): boolean
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Subnet, index: number, array: Subnet[]): any
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Subnet[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Subnet | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Subnet

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Subnet, index: number, obj: Subnet[]): boolean
        • Parameters

          • this: void
          • value: Subnet
          • index: number
          • obj: Subnet[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Subnet, index: number, obj: Subnet[]): boolean
        • Parameters

          • value: Subnet
          • index: number
          • obj: Subnet[]

          Returns boolean

    • Optional thisArg: any

    Returns Subnet | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Subnet, index: number, obj: Subnet[]): boolean
        • Parameters

          • value: Subnet
          • index: number
          • obj: Subnet[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Subnet, index: number, array: Subnet[]): void
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Subnet, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Subnet

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Subnet, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Subnet

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Subnet, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Subnet

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Subnet, index: number, array: Subnet[]): U
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Subnet | undefined
  • Removes the last element from an array and returns it.

    Returns Subnet | undefined

push

  • push(...items: Subnet[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Subnet[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Subnet
  • reduce(callbackfn: function, initialValue: Subnet): Subnet
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Subnet, currentValue: Subnet, currentIndex: number, array: Subnet[]): Subnet
        • Parameters

          • previousValue: Subnet
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns Subnet

    Returns Subnet

  • Parameters

    • callbackfn: function
        • (previousValue: Subnet, currentValue: Subnet, currentIndex: number, array: Subnet[]): Subnet
        • Parameters

          • previousValue: Subnet
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns Subnet

    • initialValue: Subnet

    Returns Subnet

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Subnet, currentIndex: number, array: Subnet[]): U
        • Parameters

          • previousValue: U
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Subnet
  • reduceRight(callbackfn: function, initialValue: Subnet): Subnet
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Subnet, currentValue: Subnet, currentIndex: number, array: Subnet[]): Subnet
        • Parameters

          • previousValue: Subnet
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns Subnet

    Returns Subnet

  • Parameters

    • callbackfn: function
        • (previousValue: Subnet, currentValue: Subnet, currentIndex: number, array: Subnet[]): Subnet
        • Parameters

          • previousValue: Subnet
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns Subnet

    • initialValue: Subnet

    Returns Subnet

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Subnet, currentIndex: number, array: Subnet[]): U
        • Parameters

          • previousValue: U
          • currentValue: Subnet
          • currentIndex: number
          • array: Subnet[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Subnet[]
  • Reverses the elements in an Array.

    Returns Subnet[]

shift

  • shift(): Subnet | undefined
  • Removes the first element from an array and returns it.

    Returns Subnet | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Subnet[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Subnet[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Subnet, index: number, array: Subnet[]): boolean
        • Parameters

          • value: Subnet
          • index: number
          • array: Subnet[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Subnet[]
  • splice(start: number, deleteCount: number, ...items: Subnet[]): Subnet[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Subnet[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Subnet[]

      Elements to insert into the array in place of the deleted elements.

    Returns Subnet[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Subnet[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Subnet[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Subnet>
  • Returns an iterable of values in the array

    Returns IterableIterator<Subnet>

type

type: object

className

className: string = "SubnetListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

Const TagsObject

TagsObject: object

Tags object for patch operations.

serializedName

serializedName: string = "TagsObject"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

className

className: string = "TagsObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const TunnelConnectionHealth

TunnelConnectionHealth: object

VirtualNetworkGatewayConnection properties

Optional connectionStatus

Virtual network Gateway connection status. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected' NOTE: This property will not be serialized. It can only be populated by the server.

Optional egressBytesTransferred

egressBytesTransferred: undefined | number

The Egress Bytes Transferred in this connection NOTE: This property will not be serialized. It can only be populated by the server.

Optional ingressBytesTransferred

ingressBytesTransferred: undefined | number

The Ingress Bytes Transferred in this connection NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastConnectionEstablishedUtcTime

lastConnectionEstablishedUtcTime: undefined | string

The time at which connection was established in Utc format. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TunnelConnectionHealth"

Optional tunnel

tunnel: undefined | string

Tunnel name. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "TunnelConnectionHealth"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionStatus

connectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "connectionStatus"

type

type: object

name

name: "String" = "String"

egressBytesTransferred

egressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "egressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

ingressBytesTransferred

ingressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "ingressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

lastConnectionEstablishedUtcTime

lastConnectionEstablishedUtcTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastConnectionEstablishedUtcTime"

type

type: object

name

name: "String" = "String"

tunnel

tunnel: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tunnel"

type

type: object

name

name: "String" = "String"

Const VirtualNetwork

VirtualNetwork: object

Virtual Network resource.

Optional addressSpace

addressSpace: AddressSpace

The AddressSpace that contains an array of IP address ranges that can be used by subnets.

Optional dhcpOptions

dhcpOptions: DhcpOptions

The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.

Optional enableDdosProtection

enableDdosProtection: undefined | false | true

Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network.

Optional enableVmProtection

enableVmProtection: undefined | false | true

Indicates if Vm protection is enabled for all the subnets in a Virtual Network.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Optional resourceGuid

resourceGuid: undefined | string

The resourceGuid property of the Virtual Network resource.

serializedName

serializedName: string = "VirtualNetwork"

Optional subnets

subnets: Subnet[]

A list of subnets in a Virtual Network.

Optional tags

tags: undefined | object

Resource tags.

Optional virtualNetworkPeerings

virtualNetworkPeerings: VirtualNetworkPeering[]

A list of peerings in a Virtual Network.

type

type: object

className

className: string = "VirtualNetwork"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

addressSpace

addressSpace: object

serializedName

serializedName: string = "properties.addressSpace"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

dhcpOptions

dhcpOptions: object

serializedName

serializedName: string = "properties.dhcpOptions"

type

type: object

className

className: string = "DhcpOptions"

name

name: "Composite" = "Composite"

enableDdosProtection

enableDdosProtection: object

serializedName

serializedName: string = "properties.enableDdosProtection"

type

type: object

name

name: "Boolean" = "Boolean"

enableVmProtection

enableVmProtection: object

serializedName

serializedName: string = "properties.enableVmProtection"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

subnets

subnets: object

serializedName

serializedName: string = "properties.subnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Subnet"

name

name: "Composite" = "Composite"

virtualNetworkPeerings

virtualNetworkPeerings: object

serializedName

serializedName: string = "properties.virtualNetworkPeerings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkPeering"

name

name: "Composite" = "Composite"

Const VirtualNetworkConnectionGatewayReference

VirtualNetworkConnectionGatewayReference: object

A reference to VirtualNetworkGateway or LocalNetworkGateway resource.

id

id: string

The ID of VirtualNetworkGateway or LocalNetworkGateway resource.

serializedName

serializedName: string = "virtualNetworkConnectionGatewayReference"

type

type: object

className

className: string = "VirtualNetworkConnectionGatewayReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkGateway

VirtualNetworkGateway: object

A common class for general resource information

Optional activeActive

activeActive: undefined | false | true

ActiveActive flag

Optional bgpSettings

bgpSettings: BgpSettings

Virtual network gateway's BGP speaker settings.

Optional enableBgp

enableBgp: undefined | false | true

Whether BGP is enabled for this virtual network gateway or not.

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional gatewayDefaultSite

gatewayDefaultSite: SubResource

The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.

Optional gatewayType

The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. Possible values include: 'Vpn', 'ExpressRoute'

Optional id

id: undefined | string

Resource ID.

Optional ipConfigurations

ipConfigurations: VirtualNetworkGatewayIPConfiguration[]

IP configurations for virtual network gateway.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the VirtualNetworkGateway resource.

serializedName

serializedName: string = "VirtualNetworkGateway"

Optional sku

The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

Optional tags

tags: undefined | object

Resource tags.

Optional vpnClientConfiguration

vpnClientConfiguration: VpnClientConfiguration

The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

Optional vpnType

vpnType: VpnType

The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased'

type

type: object

className

className: string = "VirtualNetworkGateway"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activeActive

activeActive: object

serializedName

serializedName: string = "properties.activeActive"

type

type: object

name

name: "Boolean" = "Boolean"

bgpSettings

bgpSettings: object

serializedName

serializedName: string = "properties.bgpSettings"

type

type: object

className

className: string = "BgpSettings"

name

name: "Composite" = "Composite"

enableBgp

enableBgp: object

serializedName

serializedName: string = "properties.enableBgp"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

gatewayDefaultSite

gatewayDefaultSite: object

serializedName

serializedName: string = "properties.gatewayDefaultSite"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

gatewayType

gatewayType: object

serializedName

serializedName: string = "properties.gatewayType"

type

type: object

name

name: "String" = "String"

ipConfigurations

ipConfigurations: object

serializedName

serializedName: string = "properties.ipConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkGatewayIPConfiguration"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

className

className: string = "VirtualNetworkGatewaySku"

name

name: "Composite" = "Composite"

vpnClientConfiguration

vpnClientConfiguration: object

serializedName

serializedName: string = "properties.vpnClientConfiguration"

type

type: object

className

className: string = "VpnClientConfiguration"

name

name: "Composite" = "Composite"

vpnType

vpnType: object

serializedName

serializedName: string = "properties.vpnType"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkGatewayConnection

VirtualNetworkGatewayConnection: object

A common class for general resource information

Optional authorizationKey

authorizationKey: undefined | string

The authorizationKey.

Optional connectionStatus

Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected' NOTE: This property will not be serialized. It can only be populated by the server.

connectionType

Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient'

Optional egressBytesTransferred

egressBytesTransferred: undefined | number

The egress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enableBgp

enableBgp: undefined | false | true

EnableBgp flag

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional ingressBytesTransferred

ingressBytesTransferred: undefined | number

The ingress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipsecPolicies

ipsecPolicies: IpsecPolicy[]

The IPSec Policies to be considered by this connection.

Optional localNetworkGateway2

localNetworkGateway2: LocalNetworkGateway

The reference to local network gateway resource.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peer

The reference to peerings resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the VirtualNetworkGatewayConnection resource.

Optional routingWeight

routingWeight: undefined | number

The routing weight.

serializedName

serializedName: string = "VirtualNetworkGatewayConnection"

Optional sharedKey

sharedKey: undefined | string

The IPSec shared key.

Optional tags

tags: undefined | object

Resource tags.

Optional tunnelConnectionStatus

tunnelConnectionStatus: TunnelConnectionHealth[]

Collection of all tunnels' connection health status. NOTE: This property will not be serialized. It can only be populated by the server.

Optional usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: undefined | false | true

Enable policy-based traffic selectors.

virtualNetworkGateway1

virtualNetworkGateway1: VirtualNetworkGateway

The reference to virtual network gateway resource.

Optional virtualNetworkGateway2

virtualNetworkGateway2: VirtualNetworkGateway

The reference to virtual network gateway resource.

type

type: object

className

className: string = "VirtualNetworkGatewayConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationKey

authorizationKey: object

serializedName

serializedName: string = "properties.authorizationKey"

type

type: object

name

name: "String" = "String"

connectionStatus

connectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.connectionStatus"

type

type: object

name

name: "String" = "String"

connectionType

connectionType: object

required

required: true = true

serializedName

serializedName: string = "properties.connectionType"

type

type: object

name

name: "String" = "String"

egressBytesTransferred

egressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.egressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

enableBgp

enableBgp: object

serializedName

serializedName: string = "properties.enableBgp"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ingressBytesTransferred

ingressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ingressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

ipsecPolicies

ipsecPolicies: object

serializedName

serializedName: string = "properties.ipsecPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpsecPolicy"

name

name: "Composite" = "Composite"

localNetworkGateway2

localNetworkGateway2: object

serializedName

serializedName: string = "properties.localNetworkGateway2"

type

type: object

className

className: string = "LocalNetworkGateway"

name

name: "Composite" = "Composite"

peer

peer: object

serializedName

serializedName: string = "properties.peer"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

routingWeight

routingWeight: object

serializedName

serializedName: string = "properties.routingWeight"

type

type: object

name

name: "Number" = "Number"

sharedKey

sharedKey: object

serializedName

serializedName: string = "properties.sharedKey"

type

type: object

name

name: "String" = "String"

tunnelConnectionStatus

tunnelConnectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tunnelConnectionStatus"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TunnelConnectionHealth"

name

name: "Composite" = "Composite"

usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: object

serializedName

serializedName: string = "properties.usePolicyBasedTrafficSelectors"

type

type: object

name

name: "Boolean" = "Boolean"

virtualNetworkGateway1

virtualNetworkGateway1: object

required

required: true = true

serializedName

serializedName: string = "properties.virtualNetworkGateway1"

type

type: object

className

className: string = "VirtualNetworkGateway"

name

name: "Composite" = "Composite"

virtualNetworkGateway2

virtualNetworkGateway2: object

serializedName

serializedName: string = "properties.virtualNetworkGateway2"

type

type: object

className

className: string = "VirtualNetworkGateway"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewayConnectionListEntity

VirtualNetworkGatewayConnectionListEntity: object

A common class for general resource information

Optional authorizationKey

authorizationKey: undefined | string

The authorizationKey.

Optional connectionStatus

Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected' NOTE: This property will not be serialized. It can only be populated by the server.

connectionType

Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient'

Optional egressBytesTransferred

egressBytesTransferred: undefined | number

The egress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enableBgp

enableBgp: undefined | false | true

EnableBgp flag

Optional etag

etag: undefined | string

Gets a unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional ingressBytesTransferred

ingressBytesTransferred: undefined | number

The ingress bytes transferred in this connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipsecPolicies

ipsecPolicies: IpsecPolicy[]

The IPSec Policies to be considered by this connection.

Optional localNetworkGateway2

The reference to local network gateway resource.

Optional location

location: undefined | string

Resource location.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional peer

The reference to peerings resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGuid

resourceGuid: undefined | string

The resource GUID property of the VirtualNetworkGatewayConnection resource.

Optional routingWeight

routingWeight: undefined | number

The routing weight.

serializedName

serializedName: string = "VirtualNetworkGatewayConnectionListEntity"

Optional sharedKey

sharedKey: undefined | string

The IPSec shared key.

Optional tags

tags: undefined | object

Resource tags.

Optional tunnelConnectionStatus

tunnelConnectionStatus: TunnelConnectionHealth[]

Collection of all tunnels' connection health status. NOTE: This property will not be serialized. It can only be populated by the server.

Optional usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: undefined | false | true

Enable policy-based traffic selectors.

virtualNetworkGateway1

virtualNetworkGateway1: VirtualNetworkConnectionGatewayReference

The reference to virtual network gateway resource.

Optional virtualNetworkGateway2

The reference to virtual network gateway resource.

type

type: object

className

className: string = "VirtualNetworkGatewayConnectionListEntity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationKey

authorizationKey: object

serializedName

serializedName: string = "properties.authorizationKey"

type

type: object

name

name: "String" = "String"

connectionStatus

connectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.connectionStatus"

type

type: object

name

name: "String" = "String"

connectionType

connectionType: object

required

required: true = true

serializedName

serializedName: string = "properties.connectionType"

type

type: object

name

name: "String" = "String"

egressBytesTransferred

egressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.egressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

enableBgp

enableBgp: object

serializedName

serializedName: string = "properties.enableBgp"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

ingressBytesTransferred

ingressBytesTransferred: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ingressBytesTransferred"

type

type: object

name

name: "Number" = "Number"

ipsecPolicies

ipsecPolicies: object

serializedName

serializedName: string = "properties.ipsecPolicies"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpsecPolicy"

name

name: "Composite" = "Composite"

localNetworkGateway2

localNetworkGateway2: object

serializedName

serializedName: string = "properties.localNetworkGateway2"

type

type: object

className

className: string = "VirtualNetworkConnectionGatewayReference"

name

name: "Composite" = "Composite"

peer

peer: object

serializedName

serializedName: string = "properties.peer"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceGuid

resourceGuid: object

serializedName

serializedName: string = "properties.resourceGuid"

type

type: object

name

name: "String" = "String"

routingWeight

routingWeight: object

serializedName

serializedName: string = "properties.routingWeight"

type

type: object

name

name: "Number" = "Number"

sharedKey

sharedKey: object

serializedName

serializedName: string = "properties.sharedKey"

type

type: object

name

name: "String" = "String"

tunnelConnectionStatus

tunnelConnectionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tunnelConnectionStatus"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TunnelConnectionHealth"

name

name: "Composite" = "Composite"

usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: object

serializedName

serializedName: string = "properties.usePolicyBasedTrafficSelectors"

type

type: object

name

name: "Boolean" = "Boolean"

virtualNetworkGateway1

virtualNetworkGateway1: object

required

required: true = true

serializedName

serializedName: string = "properties.virtualNetworkGateway1"

type

type: object

className

className: string = "VirtualNetworkConnectionGatewayReference"

name

name: "Composite" = "Composite"

virtualNetworkGateway2

virtualNetworkGateway2: object

serializedName

serializedName: string = "properties.virtualNetworkGateway2"

type

type: object

className

className: string = "VirtualNetworkConnectionGatewayReference"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewayConnectionListResult

VirtualNetworkGatewayConnectionListResult: object
interface

Response for the ListVirtualNetworkGatewayConnections API service call

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkGatewayConnectionListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkGatewayConnection>
  • Iterator

    Returns IterableIterator<VirtualNetworkGatewayConnection>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkGatewayConnection>[]): VirtualNetworkGatewayConnection[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkGatewayConnection[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkGatewayConnection>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGatewayConnection[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGatewayConnection[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkGatewayConnection]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkGatewayConnection]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkGatewayConnection, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkGatewayConnection

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkGatewayConnection[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkGatewayConnection

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): any
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkGatewayConnection[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkGatewayConnection | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkGatewayConnection

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkGatewayConnection, index: number, obj: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkGatewayConnection
          • index: number
          • obj: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkGatewayConnection, index: number, obj: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • obj: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkGatewayConnection | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkGatewayConnection, index: number, obj: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • obj: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): void
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkGatewayConnection, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkGatewayConnection

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkGatewayConnection, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkGatewayConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkGatewayConnection, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkGatewayConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): U
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkGatewayConnection | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkGatewayConnection | undefined

push

  • push(...items: VirtualNetworkGatewayConnection[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkGatewayConnection[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkGatewayConnection
  • reduce(callbackfn: function, initialValue: VirtualNetworkGatewayConnection): VirtualNetworkGatewayConnection
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGatewayConnection, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): VirtualNetworkGatewayConnection
        • Parameters

          • previousValue: VirtualNetworkGatewayConnection
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns VirtualNetworkGatewayConnection

    Returns VirtualNetworkGatewayConnection

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGatewayConnection, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): VirtualNetworkGatewayConnection
        • Parameters

          • previousValue: VirtualNetworkGatewayConnection
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns VirtualNetworkGatewayConnection

    • initialValue: VirtualNetworkGatewayConnection

    Returns VirtualNetworkGatewayConnection

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkGatewayConnection
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkGatewayConnection): VirtualNetworkGatewayConnection
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGatewayConnection, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): VirtualNetworkGatewayConnection
        • Parameters

          • previousValue: VirtualNetworkGatewayConnection
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns VirtualNetworkGatewayConnection

    Returns VirtualNetworkGatewayConnection

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGatewayConnection, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): VirtualNetworkGatewayConnection
        • Parameters

          • previousValue: VirtualNetworkGatewayConnection
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns VirtualNetworkGatewayConnection

    • initialValue: VirtualNetworkGatewayConnection

    Returns VirtualNetworkGatewayConnection

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGatewayConnection, currentIndex: number, array: VirtualNetworkGatewayConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGatewayConnection
          • currentIndex: number
          • array: VirtualNetworkGatewayConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkGatewayConnection[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkGatewayConnection[]

shift

  • shift(): VirtualNetworkGatewayConnection | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkGatewayConnection | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkGatewayConnection[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkGatewayConnection[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkGatewayConnection, index: number, array: VirtualNetworkGatewayConnection[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnection
          • index: number
          • array: VirtualNetworkGatewayConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkGatewayConnection[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkGatewayConnection[]): VirtualNetworkGatewayConnection[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkGatewayConnection[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkGatewayConnection[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkGatewayConnection[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkGatewayConnection[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkGatewayConnection[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkGatewayConnection>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkGatewayConnection>

type

type: object

className

className: string = "VirtualNetworkGatewayConnectionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkGatewayConnection"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayIPConfiguration: object

IP configuration for virtual network gateway

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional privateIPAllocationMethod

privateIPAllocationMethod: IPAllocationMethod

The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic'

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicIPAddress

publicIPAddress: SubResource

The reference of the public IP resource.

serializedName

serializedName: string = "VirtualNetworkGatewayIPConfiguration"

Optional subnet

subnet: SubResource

The reference of the subnet resource.

type

type: object

className

className: string = "VirtualNetworkGatewayIPConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

privateIPAllocationMethod

privateIPAllocationMethod: object

serializedName

serializedName: string = "properties.privateIPAllocationMethod"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

serializedName

serializedName: string = "properties.publicIPAddress"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

subnet

subnet: object

serializedName

serializedName: string = "properties.subnet"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewayListConnectionsResult

VirtualNetworkGatewayListConnectionsResult: object
interface

Response for the VirtualNetworkGatewayListConnections API service call

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkGatewayListConnectionsResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkGatewayConnectionListEntity>
  • Iterator

    Returns IterableIterator<VirtualNetworkGatewayConnectionListEntity>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkGatewayConnectionListEntity>[]): VirtualNetworkGatewayConnectionListEntity[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkGatewayConnectionListEntity[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkGatewayConnectionListEntity>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGatewayConnectionListEntity[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGatewayConnectionListEntity[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkGatewayConnectionListEntity]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkGatewayConnectionListEntity]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkGatewayConnectionListEntity, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkGatewayConnectionListEntity

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkGatewayConnectionListEntity[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkGatewayConnectionListEntity

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): any
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkGatewayConnectionListEntity[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkGatewayConnectionListEntity | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkGatewayConnectionListEntity

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkGatewayConnectionListEntity, index: number, obj: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • obj: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, obj: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • obj: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkGatewayConnectionListEntity | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, obj: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • obj: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): void
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkGatewayConnectionListEntity, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkGatewayConnectionListEntity

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkGatewayConnectionListEntity, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkGatewayConnectionListEntity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkGatewayConnectionListEntity, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkGatewayConnectionListEntity

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): U
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkGatewayConnectionListEntity | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkGatewayConnectionListEntity | undefined

push

  • push(...items: VirtualNetworkGatewayConnectionListEntity[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkGatewayConnectionListEntity[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkGatewayConnectionListEntity
  • reduce(callbackfn: function, initialValue: VirtualNetworkGatewayConnectionListEntity): VirtualNetworkGatewayConnectionListEntity
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGatewayConnectionListEntity, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): VirtualNetworkGatewayConnectionListEntity
        • Parameters

          • previousValue: VirtualNetworkGatewayConnectionListEntity
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns VirtualNetworkGatewayConnectionListEntity

    Returns VirtualNetworkGatewayConnectionListEntity

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGatewayConnectionListEntity, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): VirtualNetworkGatewayConnectionListEntity
        • Parameters

          • previousValue: VirtualNetworkGatewayConnectionListEntity
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns VirtualNetworkGatewayConnectionListEntity

    • initialValue: VirtualNetworkGatewayConnectionListEntity

    Returns VirtualNetworkGatewayConnectionListEntity

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkGatewayConnectionListEntity
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkGatewayConnectionListEntity): VirtualNetworkGatewayConnectionListEntity
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGatewayConnectionListEntity, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): VirtualNetworkGatewayConnectionListEntity
        • Parameters

          • previousValue: VirtualNetworkGatewayConnectionListEntity
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns VirtualNetworkGatewayConnectionListEntity

    Returns VirtualNetworkGatewayConnectionListEntity

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGatewayConnectionListEntity, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): VirtualNetworkGatewayConnectionListEntity
        • Parameters

          • previousValue: VirtualNetworkGatewayConnectionListEntity
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns VirtualNetworkGatewayConnectionListEntity

    • initialValue: VirtualNetworkGatewayConnectionListEntity

    Returns VirtualNetworkGatewayConnectionListEntity

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGatewayConnectionListEntity, currentIndex: number, array: VirtualNetworkGatewayConnectionListEntity[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGatewayConnectionListEntity
          • currentIndex: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkGatewayConnectionListEntity[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkGatewayConnectionListEntity[]

shift

  • shift(): VirtualNetworkGatewayConnectionListEntity | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkGatewayConnectionListEntity | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkGatewayConnectionListEntity[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkGatewayConnectionListEntity[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkGatewayConnectionListEntity, index: number, array: VirtualNetworkGatewayConnectionListEntity[]): boolean
        • Parameters

          • value: VirtualNetworkGatewayConnectionListEntity
          • index: number
          • array: VirtualNetworkGatewayConnectionListEntity[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkGatewayConnectionListEntity[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkGatewayConnectionListEntity[]): VirtualNetworkGatewayConnectionListEntity[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkGatewayConnectionListEntity[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkGatewayConnectionListEntity[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkGatewayConnectionListEntity[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkGatewayConnectionListEntity[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkGatewayConnectionListEntity[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkGatewayConnectionListEntity>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkGatewayConnectionListEntity>

type

type: object

className

className: string = "VirtualNetworkGatewayListConnectionsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkGatewayConnectionListEntity"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewayListResult

VirtualNetworkGatewayListResult: object
interface

Response for the ListVirtualNetworkGateways API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkGatewayListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkGateway>
  • Iterator

    Returns IterableIterator<VirtualNetworkGateway>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkGateway>[]): VirtualNetworkGateway[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkGateway[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkGateway>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGateway[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkGateway[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkGateway]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkGateway]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): boolean
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkGateway, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkGateway

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkGateway[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkGateway

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): boolean
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): any
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkGateway[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkGateway | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkGateway

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkGateway, index: number, obj: VirtualNetworkGateway[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkGateway
          • index: number
          • obj: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkGateway, index: number, obj: VirtualNetworkGateway[]): boolean
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • obj: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkGateway | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkGateway, index: number, obj: VirtualNetworkGateway[]): boolean
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • obj: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): void
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkGateway, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkGateway

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkGateway, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkGateway, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkGateway

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): U
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkGateway | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkGateway | undefined

push

  • push(...items: VirtualNetworkGateway[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkGateway[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkGateway
  • reduce(callbackfn: function, initialValue: VirtualNetworkGateway): VirtualNetworkGateway
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGateway, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): VirtualNetworkGateway
        • Parameters

          • previousValue: VirtualNetworkGateway
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns VirtualNetworkGateway

    Returns VirtualNetworkGateway

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGateway, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): VirtualNetworkGateway
        • Parameters

          • previousValue: VirtualNetworkGateway
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns VirtualNetworkGateway

    • initialValue: VirtualNetworkGateway

    Returns VirtualNetworkGateway

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkGateway
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkGateway): VirtualNetworkGateway
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkGateway, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): VirtualNetworkGateway
        • Parameters

          • previousValue: VirtualNetworkGateway
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns VirtualNetworkGateway

    Returns VirtualNetworkGateway

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkGateway, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): VirtualNetworkGateway
        • Parameters

          • previousValue: VirtualNetworkGateway
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns VirtualNetworkGateway

    • initialValue: VirtualNetworkGateway

    Returns VirtualNetworkGateway

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkGateway, currentIndex: number, array: VirtualNetworkGateway[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkGateway
          • currentIndex: number
          • array: VirtualNetworkGateway[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkGateway[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkGateway[]

shift

  • shift(): VirtualNetworkGateway | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkGateway | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkGateway[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkGateway[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkGateway, index: number, array: VirtualNetworkGateway[]): boolean
        • Parameters

          • value: VirtualNetworkGateway
          • index: number
          • array: VirtualNetworkGateway[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkGateway[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkGateway[]): VirtualNetworkGateway[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkGateway[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkGateway[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkGateway[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkGateway[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkGateway[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkGateway>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkGateway>

type

type: object

className

className: string = "VirtualNetworkGatewayListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkGateway"

name

name: "Composite" = "Composite"

Const VirtualNetworkGatewaySku

VirtualNetworkGatewaySku: object

VirtualNetworkGatewaySku details

Optional capacity

capacity: undefined | number

The capacity.

Optional name

Gateway SKU name. Possible values include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3'

serializedName

serializedName: string = "VirtualNetworkGatewaySku"

Optional tier

Gateway SKU tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3'

type

type: object

className

className: string = "VirtualNetworkGatewaySku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacity

capacity: object

serializedName

serializedName: string = "capacity"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tier

tier: object

serializedName

serializedName: string = "tier"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkListResult

VirtualNetworkListResult: object
interface

Response for the ListVirtualNetworks API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "VirtualNetworkListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetwork>
  • Iterator

    Returns IterableIterator<VirtualNetwork>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetwork>[]): VirtualNetwork[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetwork[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetwork>[]

      Additional items to add to the end of array1.

    Returns VirtualNetwork[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetwork[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetwork]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetwork]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): boolean
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetwork, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetwork

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetwork[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetwork

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): boolean
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): any
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetwork[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetwork | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetwork

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetwork, index: number, obj: VirtualNetwork[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetwork
          • index: number
          • obj: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetwork, index: number, obj: VirtualNetwork[]): boolean
        • Parameters

          • value: VirtualNetwork
          • index: number
          • obj: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetwork | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetwork, index: number, obj: VirtualNetwork[]): boolean
        • Parameters

          • value: VirtualNetwork
          • index: number
          • obj: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): void
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetwork, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetwork

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetwork, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetwork

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetwork, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetwork

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): U
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetwork | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetwork | undefined

push

  • push(...items: VirtualNetwork[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetwork[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetwork
  • reduce(callbackfn: function, initialValue: VirtualNetwork): VirtualNetwork
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetwork, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): VirtualNetwork
        • Parameters

          • previousValue: VirtualNetwork
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns VirtualNetwork

    Returns VirtualNetwork

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetwork, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): VirtualNetwork
        • Parameters

          • previousValue: VirtualNetwork
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns VirtualNetwork

    • initialValue: VirtualNetwork

    Returns VirtualNetwork

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetwork
  • reduceRight(callbackfn: function, initialValue: VirtualNetwork): VirtualNetwork
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetwork, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): VirtualNetwork
        • Parameters

          • previousValue: VirtualNetwork
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns VirtualNetwork

    Returns VirtualNetwork

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetwork, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): VirtualNetwork
        • Parameters

          • previousValue: VirtualNetwork
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns VirtualNetwork

    • initialValue: VirtualNetwork

    Returns VirtualNetwork

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetwork, currentIndex: number, array: VirtualNetwork[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetwork
          • currentIndex: number
          • array: VirtualNetwork[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetwork[]
  • Reverses the elements in an Array.

    Returns VirtualNetwork[]

shift

  • shift(): VirtualNetwork | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetwork | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetwork[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetwork[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetwork, index: number, array: VirtualNetwork[]): boolean
        • Parameters

          • value: VirtualNetwork
          • index: number
          • array: VirtualNetwork[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetwork[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetwork[]): VirtualNetwork[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetwork[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetwork[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetwork[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetwork[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetwork[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetwork>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetwork>

type

type: object

className

className: string = "VirtualNetworkListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetwork"

name

name: "Composite" = "Composite"

Const VirtualNetworkListUsageResult

VirtualNetworkListUsageResult: object
interface

Response for the virtual networks GetUsage API service call.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "VirtualNetworkListUsageResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkUsage>
  • Iterator

    Returns IterableIterator<VirtualNetworkUsage>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkUsage>[]): VirtualNetworkUsage[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkUsage[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkUsage>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkUsage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkUsage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkUsage]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkUsage]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): boolean
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkUsage, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkUsage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkUsage[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkUsage

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): boolean
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): any
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkUsage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkUsage | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkUsage

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkUsage, index: number, obj: VirtualNetworkUsage[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkUsage
          • index: number
          • obj: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkUsage, index: number, obj: VirtualNetworkUsage[]): boolean
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • obj: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkUsage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkUsage, index: number, obj: VirtualNetworkUsage[]): boolean
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • obj: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): void
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkUsage, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkUsage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkUsage, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkUsage, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): U
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkUsage | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkUsage | undefined

push

  • push(...items: VirtualNetworkUsage[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkUsage[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkUsage
  • reduce(callbackfn: function, initialValue: VirtualNetworkUsage): VirtualNetworkUsage
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkUsage, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): VirtualNetworkUsage
        • Parameters

          • previousValue: VirtualNetworkUsage
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns VirtualNetworkUsage

    Returns VirtualNetworkUsage

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkUsage, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): VirtualNetworkUsage
        • Parameters

          • previousValue: VirtualNetworkUsage
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns VirtualNetworkUsage

    • initialValue: VirtualNetworkUsage

    Returns VirtualNetworkUsage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkUsage
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkUsage): VirtualNetworkUsage
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkUsage, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): VirtualNetworkUsage
        • Parameters

          • previousValue: VirtualNetworkUsage
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns VirtualNetworkUsage

    Returns VirtualNetworkUsage

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkUsage, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): VirtualNetworkUsage
        • Parameters

          • previousValue: VirtualNetworkUsage
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns VirtualNetworkUsage

    • initialValue: VirtualNetworkUsage

    Returns VirtualNetworkUsage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkUsage, currentIndex: number, array: VirtualNetworkUsage[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkUsage
          • currentIndex: number
          • array: VirtualNetworkUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkUsage[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkUsage[]

shift

  • shift(): VirtualNetworkUsage | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkUsage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkUsage[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkUsage[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkUsage, index: number, array: VirtualNetworkUsage[]): boolean
        • Parameters

          • value: VirtualNetworkUsage
          • index: number
          • array: VirtualNetworkUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkUsage[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkUsage[]): VirtualNetworkUsage[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkUsage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkUsage[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkUsage[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkUsage[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkUsage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkUsage>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkUsage>

type

type: object

className

className: string = "VirtualNetworkListUsageResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkUsage"

name

name: "Composite" = "Composite"

Const VirtualNetworkPeering

VirtualNetworkPeering: object

Peerings in a virtual network resource.

Optional allowForwardedTraffic

allowForwardedTraffic: undefined | false | true

Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.

Optional allowGatewayTransit

allowGatewayTransit: undefined | false | true

If gateway links can be used in remote virtual networking to link to this virtual network.

Optional allowVirtualNetworkAccess

allowVirtualNetworkAccess: undefined | false | true

Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional peeringState

The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. Possible values include: 'Initiated', 'Connected', 'Disconnected'

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the resource.

Optional remoteAddressSpace

remoteAddressSpace: AddressSpace

The reference of the remote virtual network address space.

Optional remoteVirtualNetwork

remoteVirtualNetwork: SubResource

The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).

serializedName

serializedName: string = "VirtualNetworkPeering"

Optional useRemoteGateways

useRemoteGateways: undefined | false | true

If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.

type

type: object

className

className: string = "VirtualNetworkPeering"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowForwardedTraffic

allowForwardedTraffic: object

serializedName

serializedName: string = "properties.allowForwardedTraffic"

type

type: object

name

name: "Boolean" = "Boolean"

allowGatewayTransit

allowGatewayTransit: object

serializedName

serializedName: string = "properties.allowGatewayTransit"

type

type: object

name

name: "Boolean" = "Boolean"

allowVirtualNetworkAccess

allowVirtualNetworkAccess: object

serializedName

serializedName: string = "properties.allowVirtualNetworkAccess"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

peeringState

peeringState: object

serializedName

serializedName: string = "properties.peeringState"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

remoteAddressSpace

remoteAddressSpace: object

serializedName

serializedName: string = "properties.remoteAddressSpace"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

remoteVirtualNetwork

remoteVirtualNetwork: object

serializedName

serializedName: string = "properties.remoteVirtualNetwork"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

useRemoteGateways

useRemoteGateways: object

serializedName

serializedName: string = "properties.useRemoteGateways"

type

type: object

name

name: "Boolean" = "Boolean"

Const VirtualNetworkPeeringListResult

VirtualNetworkPeeringListResult: object
interface

Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "VirtualNetworkPeeringListResult"

__@iterator

  • __@iterator(): IterableIterator<VirtualNetworkPeering>
  • Iterator

    Returns IterableIterator<VirtualNetworkPeering>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VirtualNetworkPeering>[]): VirtualNetworkPeering[]
  • concat(...items: (T | ConcatArray<T>)[]): VirtualNetworkPeering[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VirtualNetworkPeering>[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkPeering[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VirtualNetworkPeering[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VirtualNetworkPeering]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VirtualNetworkPeering]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): boolean
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VirtualNetworkPeering, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VirtualNetworkPeering

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VirtualNetworkPeering[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VirtualNetworkPeering

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): boolean
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): any
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VirtualNetworkPeering[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VirtualNetworkPeering | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VirtualNetworkPeering

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VirtualNetworkPeering, index: number, obj: VirtualNetworkPeering[]): boolean
        • Parameters

          • this: void
          • value: VirtualNetworkPeering
          • index: number
          • obj: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VirtualNetworkPeering, index: number, obj: VirtualNetworkPeering[]): boolean
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • obj: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

    Returns VirtualNetworkPeering | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VirtualNetworkPeering, index: number, obj: VirtualNetworkPeering[]): boolean
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • obj: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): void
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VirtualNetworkPeering, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VirtualNetworkPeering

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VirtualNetworkPeering, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VirtualNetworkPeering

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VirtualNetworkPeering, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VirtualNetworkPeering

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): U
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VirtualNetworkPeering | undefined
  • Removes the last element from an array and returns it.

    Returns VirtualNetworkPeering | undefined

push

  • push(...items: VirtualNetworkPeering[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VirtualNetworkPeering[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VirtualNetworkPeering
  • reduce(callbackfn: function, initialValue: VirtualNetworkPeering): VirtualNetworkPeering
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkPeering, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): VirtualNetworkPeering
        • Parameters

          • previousValue: VirtualNetworkPeering
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns VirtualNetworkPeering

    Returns VirtualNetworkPeering

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkPeering, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): VirtualNetworkPeering
        • Parameters

          • previousValue: VirtualNetworkPeering
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns VirtualNetworkPeering

    • initialValue: VirtualNetworkPeering

    Returns VirtualNetworkPeering

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VirtualNetworkPeering
  • reduceRight(callbackfn: function, initialValue: VirtualNetworkPeering): VirtualNetworkPeering
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VirtualNetworkPeering, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): VirtualNetworkPeering
        • Parameters

          • previousValue: VirtualNetworkPeering
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns VirtualNetworkPeering

    Returns VirtualNetworkPeering

  • Parameters

    • callbackfn: function
        • (previousValue: VirtualNetworkPeering, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): VirtualNetworkPeering
        • Parameters

          • previousValue: VirtualNetworkPeering
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns VirtualNetworkPeering

    • initialValue: VirtualNetworkPeering

    Returns VirtualNetworkPeering

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VirtualNetworkPeering, currentIndex: number, array: VirtualNetworkPeering[]): U
        • Parameters

          • previousValue: U
          • currentValue: VirtualNetworkPeering
          • currentIndex: number
          • array: VirtualNetworkPeering[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VirtualNetworkPeering[]
  • Reverses the elements in an Array.

    Returns VirtualNetworkPeering[]

shift

  • shift(): VirtualNetworkPeering | undefined
  • Removes the first element from an array and returns it.

    Returns VirtualNetworkPeering | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VirtualNetworkPeering[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VirtualNetworkPeering[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VirtualNetworkPeering, index: number, array: VirtualNetworkPeering[]): boolean
        • Parameters

          • value: VirtualNetworkPeering
          • index: number
          • array: VirtualNetworkPeering[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VirtualNetworkPeering[]
  • splice(start: number, deleteCount: number, ...items: VirtualNetworkPeering[]): VirtualNetworkPeering[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VirtualNetworkPeering[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VirtualNetworkPeering[]

      Elements to insert into the array in place of the deleted elements.

    Returns VirtualNetworkPeering[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VirtualNetworkPeering[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VirtualNetworkPeering[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VirtualNetworkPeering>
  • Returns an iterable of values in the array

    Returns IterableIterator<VirtualNetworkPeering>

type

type: object

className

className: string = "VirtualNetworkPeeringListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualNetworkPeering"

name

name: "Composite" = "Composite"

Const VirtualNetworkUsage

VirtualNetworkUsage: object

Usage details for subnet.

Optional currentValue

currentValue: undefined | number

Indicates number of IPs used from the Subnet. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Subnet identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional limit

limit: undefined | number

Indicates the size of the subnet. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

The name containing common and localized value for usage. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkUsage"

Optional unit

unit: undefined | string

Usage units. Returns 'Count' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "VirtualNetworkUsage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "currentValue"

type

type: object

name

name: "Number" = "Number"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

limit

limit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "VirtualNetworkUsageName"

name

name: "Composite" = "Composite"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkUsageName

VirtualNetworkUsageName: object

Usage strings container.

Optional localizedValue

localizedValue: undefined | string

Localized subnet size and usage string. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkUsageName"

Optional value

value: undefined | string

Subnet size and usage string. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "VirtualNetworkUsageName"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValue

localizedValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "localizedValue"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const VpnClientConfiguration

VpnClientConfiguration: object

VpnClientConfiguration for P2S client.

Optional radiusServerAddress

radiusServerAddress: undefined | string

The radius server address property of the VirtualNetworkGateway resource for vpn client connection.

Optional radiusServerSecret

radiusServerSecret: undefined | string

The radius secret property of the VirtualNetworkGateway resource for vpn client connection.

serializedName

serializedName: string = "VpnClientConfiguration"

Optional vpnClientAddressPool

vpnClientAddressPool: AddressSpace

The reference of the address space resource which represents Address space for P2S VpnClient.

Optional vpnClientProtocols

vpnClientProtocols: VpnClientProtocol[]

VpnClientProtocols for Virtual network gateway.

Optional vpnClientRevokedCertificates

vpnClientRevokedCertificates: VpnClientRevokedCertificate[]

VpnClientRevokedCertificate for Virtual network gateway.

Optional vpnClientRootCertificates

vpnClientRootCertificates: VpnClientRootCertificate[]

VpnClientRootCertificate for virtual network gateway.

type

type: object

className

className: string = "VpnClientConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

radiusServerAddress

radiusServerAddress: object

serializedName

serializedName: string = "radiusServerAddress"

type

type: object

name

name: "String" = "String"

radiusServerSecret

radiusServerSecret: object

serializedName

serializedName: string = "radiusServerSecret"

type

type: object

name

name: "String" = "String"

vpnClientAddressPool

vpnClientAddressPool: object

serializedName

serializedName: string = "vpnClientAddressPool"

type

type: object

className

className: string = "AddressSpace"

name

name: "Composite" = "Composite"

vpnClientProtocols

vpnClientProtocols: object

serializedName

serializedName: string = "vpnClientProtocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

vpnClientRevokedCertificates

vpnClientRevokedCertificates: object

serializedName

serializedName: string = "vpnClientRevokedCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VpnClientRevokedCertificate"

name

name: "Composite" = "Composite"

vpnClientRootCertificates

vpnClientRootCertificates: object

serializedName

serializedName: string = "vpnClientRootCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VpnClientRootCertificate"

name

name: "Composite" = "Composite"

Const VpnClientParameters

VpnClientParameters: object

Vpn Client Parameters for package generation

Optional authenticationMethod

authenticationMethod: AuthenticationMethod

VPN client Authentication Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values include: 'EAPTLS', 'EAPMSCHAPv2'

Optional clientRootCertificates

clientRootCertificates: string[]

A list of client root certificates public certificate data encoded as Base-64 strings. Optional parameter for external radius based authentication with EAPTLS.

Optional processorArchitecture

processorArchitecture: ProcessorArchitecture

VPN client Processor Architecture. Possible values are: 'AMD64' and 'X86'. Possible values include: 'Amd64', 'X86'

Optional radiusServerAuthCertificate

radiusServerAuthCertificate: undefined | string

The public certificate data for the radius server authentication certificate as a Base-64 encoded string. Required only if external radius authentication has been configured with EAPTLS authentication.

serializedName

serializedName: string = "VpnClientParameters"

type

type: object

className

className: string = "VpnClientParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authenticationMethod

authenticationMethod: object

serializedName

serializedName: string = "authenticationMethod"

type

type: object

name

name: "String" = "String"

clientRootCertificates

clientRootCertificates: object

serializedName

serializedName: string = "clientRootCertificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

processorArchitecture

processorArchitecture: object

serializedName

serializedName: string = "processorArchitecture"

type

type: object

name

name: "String" = "String"

radiusServerAuthCertificate

radiusServerAuthCertificate: object

serializedName

serializedName: string = "radiusServerAuthCertificate"

type

type: object

name

name: "String" = "String"

Const VpnClientRevokedCertificate

VpnClientRevokedCertificate: object

VPN client revoked certificate of virtual network gateway.

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VpnClientRevokedCertificate"

Optional thumbprint

thumbprint: undefined | string

The revoked VPN client certificate thumbprint.

type

type: object

className

className: string = "VpnClientRevokedCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

Const VpnClientRootCertificate

VpnClientRootCertificate: object

VPN client root certificate of virtual network gateway

Optional etag

etag: undefined | string

A unique read-only string that changes whenever the resource is updated.

Optional id

id: undefined | string

Resource ID.

Optional name

name: undefined | string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

publicCertData

publicCertData: string

The certificate public data.

serializedName

serializedName: string = "VpnClientRootCertificate"

type

type: object

className

className: string = "VpnClientRootCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicCertData

publicCertData: object

required

required: true = true

serializedName

serializedName: string = "properties.publicCertData"

type

type: object

name

name: "String" = "String"

Const VpnDeviceScriptParameters

VpnDeviceScriptParameters: object

Vpn device configuration script generation parameters

Optional deviceFamily

deviceFamily: undefined | string

The device family for the vpn device.

Optional firmwareVersion

firmwareVersion: undefined | string

The firmware version for the vpn device.

serializedName

serializedName: string = "VpnDeviceScriptParameters"

Optional vendor

vendor: undefined | string

The vendor for the vpn device.

type

type: object

className

className: string = "VpnDeviceScriptParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deviceFamily

deviceFamily: object

serializedName

serializedName: string = "deviceFamily"

type

type: object

name

name: "String" = "String"

firmwareVersion

firmwareVersion: object

serializedName

serializedName: string = "firmwareVersion"

type

type: object

name

name: "String" = "String"

vendor

vendor: object

serializedName

serializedName: string = "vendor"

type

type: object

name

name: "String" = "String"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const backendAddressPoolName

backendAddressPoolName: object

parameterPath

parameterPath: string = "backendAddressPoolName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backendAddressPoolName"

type

type: object

name

name: "String" = "String"

Const defaultSecurityRuleName

defaultSecurityRuleName: object

parameterPath

parameterPath: string = "defaultSecurityRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "defaultSecurityRuleName"

type

type: object

name

name: "String" = "String"

Const expand

expand: object

parameterPath

parameterPath: string[] = ["options","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const frontendIPConfigurationName

frontendIPConfigurationName: object

parameterPath

parameterPath: string = "frontendIPConfigurationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "frontendIPConfigurationName"

type

type: object

name

name: "String" = "String"

Const gatewayVip

gatewayVip: object

parameterPath

parameterPath: string[] = ["options","gatewayVip"]

mapper

mapper: object

serializedName

serializedName: string = "gatewayVip"

type

type: object

name

name: "String" = "String"

Const inboundNatRuleName

inboundNatRuleName: object

parameterPath

parameterPath: string = "inboundNatRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "inboundNatRuleName"

type

type: object

name

name: "String" = "String"

Const ipAddress

ipAddress: object

parameterPath

parameterPath: string[] = ["options","ipAddress"]

mapper

mapper: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

Const ipConfigurationName

ipConfigurationName: object

parameterPath

parameterPath: string = "ipConfigurationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "ipConfigurationName"

type

type: object

name

name: "String" = "String"

Const loadBalancerName

loadBalancerName: object

parameterPath

parameterPath: string = "loadBalancerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "loadBalancerName"

type

type: object

name

name: "String" = "String"

Const loadBalancingRuleName

loadBalancingRuleName: object

parameterPath

parameterPath: string = "loadBalancingRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "loadBalancingRuleName"

type

type: object

name

name: "String" = "String"

Const localNetworkGatewayName

localNetworkGatewayName: object

parameterPath

parameterPath: string = "localNetworkGatewayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "localNetworkGatewayName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const networkInterfaceName

networkInterfaceName: object

parameterPath

parameterPath: string = "networkInterfaceName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "networkInterfaceName"

type

type: object

name

name: "String" = "String"

Const networkSecurityGroupName

networkSecurityGroupName: object

parameterPath

parameterPath: string = "networkSecurityGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "networkSecurityGroupName"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const peer0

peer0: object

parameterPath

parameterPath: string[] = ["options","peer"]

mapper

mapper: object

serializedName

serializedName: string = "peer"

type

type: object

name

name: "String" = "String"

Const peer1

peer1: object

parameterPath

parameterPath: string = "peer"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "peer"

type

type: object

name

name: "String" = "String"

Const probeName

probeName: object

parameterPath

parameterPath: string = "probeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "probeName"

type

type: object

name

name: "String" = "String"

Const publicIpAddressName

publicIpAddressName: object

parameterPath

parameterPath: string = "publicIpAddressName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "publicIpAddressName"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const routeName

routeName: object

parameterPath

parameterPath: string = "routeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "routeName"

type

type: object

name

name: "String" = "String"

Const routeTableName

routeTableName: object

parameterPath

parameterPath: string = "routeTableName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "routeTableName"

type

type: object

name

name: "String" = "String"

Const securityRuleName

securityRuleName: object

parameterPath

parameterPath: string = "securityRuleName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "securityRuleName"

type

type: object

name

name: "String" = "String"

Const subnetName

subnetName: object

parameterPath

parameterPath: string = "subnetName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subnetName"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const virtualNetworkGatewayConnectionName

virtualNetworkGatewayConnectionName: object

parameterPath

parameterPath: string = "virtualNetworkGatewayConnectionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualNetworkGatewayConnectionName"

type

type: object

name

name: "String" = "String"

Const virtualNetworkGatewayName

virtualNetworkGatewayName: object

parameterPath

parameterPath: string = "virtualNetworkGatewayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualNetworkGatewayName"

type

type: object

name

name: "String" = "String"

Const virtualNetworkName

virtualNetworkName: object

parameterPath

parameterPath: string = "virtualNetworkName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualNetworkName"

type

type: object

name

name: "String" = "String"

Const virtualNetworkPeeringName

virtualNetworkPeeringName: object

parameterPath

parameterPath: string = "virtualNetworkPeeringName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "virtualNetworkPeeringName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc